JSDoc: Global

Members

(constant) dataStorage

A storage solution aimed at replacing jQuerys data function. Implementation Note: Elements are stored in a (WeakMap)[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap]. This makes sure the data is garbage collected when the node is removed.

Source:

svgcanvas/dataStorage.js, line 5

(constant) name

This is a very basic SVG-Edit extension. It adds a "Hello World" button in the left ("mode") panel. Clicking on the button, and then the canvas will show the user the point on the canvas that was clicked on.

Source:

editor/extensions/ext-helloworld/ext-helloworld.js, line 16

Methods

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seButton.js, line 69

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seColorPicker.js, line 689

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seDropdown.js, line 64

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seExplorerButton.js, line 133

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seFlyingButton.js, line 115

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seInput.js, line 65

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seList.js, line 61

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seListItem.js, line 49

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seMenu.js, line 58

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seMenuItem.js, line 44

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/sePalette.js, line 115

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seSelect.js, line 49

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seSpinInput.js, line 83

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seText.js, line 37

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/components/seZoom.js, line 73

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/cmenuDialog.js, line 62

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/cmenuLayersDialog.js, line 48

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/editorPreferencesDialog.js, line 62

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/exportDialog.js, line 48

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/imagePropertiesDialog.js, line 64

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 15

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/sePromptDialog.js, line 24

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/dialogs/svgSourceDialog.js, line 47

Returns:

Type: void

attributeChangedCallback(name, oldValue, newValue) → {void}

Parameters:

Name	Type	Description
`name`	string
`oldValue`	string
`newValue`	string

Source:

editor/extensions/ext-storage/storageDialog.js, line 50

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seButton.js, line 212

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seColorPicker.js, line 791

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seExplorerButton.js, line 243

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seFlyingButton.js, line 239

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seInput.js, line 178

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seList.js, line 172

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seMenuItem.js, line 101

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/sePalette.js, line 130

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seSelect.js, line 188

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seSpinInput.js, line 212

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/components/seText.js, line 117

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/dialogs/cmenuDialog.js, line 192

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/dialogs/cmenuLayersDialog.js, line 114

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 331

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/dialogs/exportDialog.js, line 101

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/dialogs/imagePropertiesDialog.js, line 274

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/dialogs/svgSourceDialog.js, line 167

Returns:

Type: void

connectedCallback() → {void}

Source:

editor/extensions/ext-storage/storageDialog.js, line 126

Returns:

Type: void

constructor()

Source:

editor/components/seButton.js, line 47

constructor()

Source:

editor/components/seColorPicker.js, line 653

constructor()

Source:

editor/components/seExplorerButton.js, line 105

constructor()

Source:

editor/components/seFlyingButton.js, line 87

constructor()

Source:

editor/components/seInput.js, line 41

constructor()

Source:

editor/components/seList.js, line 38

constructor()

Source:

editor/components/seListItem.js, line 25

constructor()

Source:

editor/components/seMenu.js, line 37

constructor()

Source:

editor/components/seMenuItem.js, line 20

constructor()

Source:

editor/components/sePalette.js, line 60

constructor()

Source:

editor/components/seSelect.js, line 29

constructor()

Source:

editor/components/seSpinInput.js, line 58

constructor()

Source:

editor/components/seText.js, line 17

constructor()

Source:

editor/dialogs/cmenuDialog.js, line 9

constructor()

Source:

editor/dialogs/cmenuLayersDialog.js, line 10

constructor()

Source:

editor/dialogs/editorPreferencesDialog.js, line 9

constructor()

Source:

editor/dialogs/exportDialog.js, line 11

constructor()

Source:

editor/dialogs/imagePropertiesDialog.js, line 12

constructor()

Source:

editor/dialogs/sePromptDialog.js, line 6

constructor()

Source:

editor/dialogs/svgSourceDialog.js, line 10

constructor()

Source:

editor/extensions/ext-storage/storageDialog.js, line 10

expireCookie(cookie) → {void}

Set the cookie to expire.

Parameters:

Name	Type	Description
`cookie`	string

Source:

editor/extensions/ext-storage/ext-storage.js, line 35

Returns:

Type: void

findPos(obj) → {any}

Parameters:

Name	Type	Description
`obj`	any

Source:

editor/components/jgraduate/Util.js, line 5

Returns:

Type: any

formatValue Format the numeric value as a string. This is used after incrementing/decrementing the value to reformat the value as a string.(value, precision) → {number}

Parameters:

Name	Type	Description
`value`	number
`precision`	number

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 46

Returns:

Type: number

get() → {any}

Source:

editor/components/seButton.js, line 122

Returns:

Type: any

get() → {any}

Source:

editor/components/seButton.js, line 138

Returns:

Type: any

get() → {any}

Source:

editor/components/seButton.js, line 159

Returns:

Type: any

get() → {any}

Source:

editor/components/seButton.js, line 180

Returns:

Type: any

get() → {any}

Source:

editor/components/seButton.js, line 196

Returns:

Type: any

get() → {any}

Source:

editor/components/seColorPicker.js, line 717

Returns:

Type: any

get() → {any}

Source:

editor/components/seColorPicker.js, line 733

Returns:

Type: any

get() → {any}

Source:

editor/components/seColorPicker.js, line 749

Returns:

Type: any

get() → {PlainObject}

Source:

editor/components/seDropdown.js, line 11

Returns:

Type: PlainObject

get() → {PlainObject}

Source:

editor/components/seDropdown.js, line 23

Returns:

Type: PlainObject

get() → {any}

Source:

editor/components/seExplorerButton.js, line 185

Returns:

Type: any

get() → {any}

Source:

editor/components/seExplorerButton.js, line 201

Returns:

Type: any

get() → {any}

Source:

editor/components/seExplorerButton.js, line 222

Returns:

Type: any

get() → {any}

Source:

editor/components/seFlyingButton.js, line 158

Returns:

Type: any

get() → {any}

Source:

editor/components/seFlyingButton.js, line 174

Returns:

Type: any

get() → {any}

Source:

editor/components/seFlyingButton.js, line 197

Returns:

Type: any

get() → {any}

Source:

editor/components/seFlyingButton.js, line 218

Returns:

Type: any

get() → {any}

Source:

editor/components/seInput.js, line 98

Returns:

Type: any

get() → {any}

Source:

editor/components/seInput.js, line 114

Returns:

Type: any

get() → {any}

Source:

editor/components/seInput.js, line 130

Returns:

Type: any

get() → {any}

Source:

editor/components/seInput.js, line 146

Returns:

Type: any

get() → {any}

Source:

editor/components/seInput.js, line 162

Returns:

Type: any

get() → {any}

Source:

editor/components/seList.js, line 108

Returns:

Type: any

get() → {any}

Source:

editor/components/seList.js, line 124

Returns:

Type: any

get() → {any}

Source:

editor/components/seList.js, line 140

Returns:

Type: any

get() → {any}

Source:

editor/components/seList.js, line 156

Returns:

Type: any

get() → {any}

Source:

editor/components/seListItem.js, line 79

Returns:

Type: any

get() → {any}

Source:

editor/components/seListItem.js, line 95

Returns:

Type: any

get() → {any}

Source:

editor/components/seListItem.js, line 111

Returns:

Type: any

get() → {any}

Source:

editor/components/seListItem.js, line 127

Returns:

Type: any

get() → {any}

Source:

editor/components/seMenu.js, line 84

Returns:

Type: any

get() → {any}

Source:

editor/components/seMenu.js, line 100

Returns:

Type: any

get() → {any}

Source:

editor/components/seMenuItem.js, line 69

Returns:

Type: any

get() → {any}

Source:

editor/components/seMenuItem.js, line 85

Returns:

Type: any

get() → {PlainObject}

Source:

editor/components/sePlainBorderButton.js, line 11

Returns:

Type: PlainObject

get() → {PlainObject}

Source:

editor/components/sePlainMenuButton.js, line 9

Returns:

Type: PlainObject

get() → {any}

Source:

editor/components/seSelect.js, line 108

Returns:

Type: any

get() → {any}

Source:

editor/components/seSelect.js, line 124

Returns:

Type: any

get() → {any}

Source:

editor/components/seSelect.js, line 140

Returns:

Type: any

get() → {any}

Source:

editor/components/seSelect.js, line 156

Returns:

Type: any

get() → {any}

Source:

editor/components/seSelect.js, line 172

Returns:

Type: any

get() → {any}

Source:

editor/components/seSpinInput.js, line 132

Returns:

Type: any

get() → {any}

Source:

editor/components/seSpinInput.js, line 148

Returns:

Type: any

get() → {any}

Source:

editor/components/seSpinInput.js, line 164

Returns:

Type: any

get() → {any}

Source:

editor/components/seSpinInput.js, line 180

Returns:

Type: any

get() → {any}

Source:

editor/components/seSpinInput.js, line 196

Returns:

Type: any

get() → {any}

Source:

editor/components/seText.js, line 69

Returns:

Type: any

get() → {any}

Source:

editor/components/seText.js, line 85

Returns:

Type: any

get() → {any}

Source:

editor/components/seText.js, line 101

Returns:

Type: any

get() → {PlainObject}

Source:

editor/components/seZoom.js, line 11

Returns:

Type: PlainObject

get() → {PlainObject}

Source:

editor/components/seZoom.js, line 23

Returns:

Type: PlainObject

get() → {PlainObject}

Source:

editor/dialogs/SePlainAlertDialog.js, line 9

Returns:

Type: PlainObject

get() → {any}

Source:

editor/dialogs/cmenuDialog.js, line 144

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/cmenuDialog.js, line 160

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/cmenuDialog.js, line 176

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/cmenuLayersDialog.js, line 82

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/cmenuLayersDialog.js, line 98

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 187

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 203

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 219

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 235

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 251

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 267

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 283

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 299

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 315

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/exportDialog.js, line 85

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/imagePropertiesDialog.js, line 178

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/imagePropertiesDialog.js, line 194

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/imagePropertiesDialog.js, line 210

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/imagePropertiesDialog.js, line 226

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/imagePropertiesDialog.js, line 242

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/imagePropertiesDialog.js, line 258

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 184

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/sePromptDialog.js, line 54

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/sePromptDialog.js, line 70

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/svgSourceDialog.js, line 103

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/svgSourceDialog.js, line 119

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/svgSourceDialog.js, line 135

Returns:

Type: any

get() → {any}

Source:

editor/dialogs/svgSourceDialog.js, line 151

Returns:

Type: any

get() → {any}

Source:

editor/extensions/ext-storage/storageDialog.js, line 110

Returns:

Type: any

getClosest(elem, selector) → {Boolean|Element}

Get the closest matching element up the DOM tree.

Parameters:

Name	Type	Description
`elem`	Element	Starting element
`selector`	String	Selector to match against (class, ID, data attribute, or tag)

Source:

editor/components/jgraduate/Util.js, line 43

Returns:

Returns null if not match found

Type: Boolean | Element

getParents(elem, selector) → {Array}

Get all DOM element up the tree that contain a class, ID, or data attribute

Parameters:

Name	Type	Description
`elem`	Node	The base element
`selector`	String	The class, id, data attribute, or tag to look for

Source:

editor/components/jgraduate/Util.js, line 102

Returns:

Null if no match

Type: Array

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/components/seColorPicker.js, line 671

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/components/sePalette.js, line 98

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/dialogs/cmenuDialog.js, line 32

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/dialogs/cmenuLayersDialog.js, line 28

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/dialogs/editorPreferencesDialog.js, line 31

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/dialogs/exportDialog.js, line 28

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/dialogs/imagePropertiesDialog.js, line 32

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/dialogs/svgSourceDialog.js, line 27

Returns:

Type: void

init(name) → {void}

Parameters:

Name	Type	Description
`name`	any

Source:

editor/extensions/ext-storage/storageDialog.js, line 26

Returns:

Type: void

inputsize() → {string}

Source:

editor/components/seDropdown.js, line 135

Returns:

src

Type: string

inputsize() → {string}

Source:

editor/components/seZoom.js, line 147

Returns:

src

Type: string

isNullish(val) → {boolean}

Whether a value is null or undefined.

Parameters:

Name	Type	Description
`val`	any

Source:

editor/components/jgraduate/Slider.js, line 7

Returns:

Type: boolean

load load Config() → {void}

Source:

editor/ConfigObj.js, line 475

Returns:

Type: void

loadFromURL Load config/data from URL if given() → {void}

Source:

editor/ConfigObj.js, line 235

Returns:

Type: void

observedAttributes() → {any}

Source:

editor/components/seButton.js, line 61

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seColorPicker.js, line 681

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seDropdown.js, line 56

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seExplorerButton.js, line 125

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seFlyingButton.js, line 107

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seInput.js, line 57

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seList.js, line 53

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seListItem.js, line 41

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seMenu.js, line 50

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seMenuItem.js, line 36

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/sePalette.js, line 107

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seSelect.js, line 41

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seSpinInput.js, line 75

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seText.js, line 29

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/components/seZoom.js, line 65

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/cmenuDialog.js, line 51

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/cmenuLayersDialog.js, line 40

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/editorPreferencesDialog.js, line 53

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/exportDialog.js, line 40

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/imagePropertiesDialog.js, line 52

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 34

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/sePromptDialog.js, line 16

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/dialogs/svgSourceDialog.js, line 39

Returns:

observed

Type: any

observedAttributes() → {any}

Source:

editor/extensions/ext-storage/storageDialog.js, line 42

Returns:

observed

Type: any

parseValue(value, precision) → {int}

Parameters:

Name	Type	Description
`value`	number
`precision`	number

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 103

Returns:

Type: int

pref(key, valopt, mayBeEmptyopt) → {string|void}

Store and retrieve preferences.

Parameters:

Name	Type	Attributes	Description
`key`	string		The preference name to be retrieved or set
`val`	string	<optional>	The value. If the value supplied is missing or falsey, no change to the preference will be made unless `mayBeEmpty` is set.
`mayBeEmpty`	boolean	<optional>	If value may be falsey.

Source:

editor/ConfigObj.js, line 451

To Do:

Review whether any remaining existing direct references to getting `curPrefs` can be changed to use `svgEditor.configObj.pref()` getting to ensure `defaultPrefs` fallback (also for sake of `allowInitialUserOverride`); specifically, `bkgd_color` could be changed so that the pref dialog has a button to auto-calculate background, but otherwise uses `svgEditor.configObj.pref()` to be able to get default prefs or overridable settings

Returns:

If val is missing or falsey and mayBeEmpty is not set, the value of the previously stored preference will be returned.

Type: string | void

readySignal() → {void}

Source:

editor/EditorStartup.js, line 17

Fires:

module:svgcanvas.SvgCanvas#event:svgEditorReady

Returns:

Type: void

regexEscape(str) → {string}

Escapes special characters in a regular expression.

Parameters:

Name	Type	Description
`str`	string

Source:

editor/ConfigObj.js, line 3

Returns:

Type: string

removeStoragePrefCookie() → {void}

Expire the storage cookie.

Source:

editor/extensions/ext-storage/ext-storage.js, line 27

Returns:

Type: void

replaceStoragePrompt(val) → {void}

Replace storagePrompt parameter within URL.

Parameters:

Name	Type	Description
`val`	string

Source:

editor/extensions/ext-storage/ext-storage.js, line 46

To Do:

Replace the string manipulation with `searchParams.set`

Returns:

Type: void

set() → {void}

Source:

editor/components/seButton.js, line 130

Returns:

Type: void

set() → {void}

Source:

editor/components/seButton.js, line 146

Returns:

Type: void

set() → {void}

Source:

editor/components/seButton.js, line 167

Returns:

Type: void

set() → {void}

Source:

editor/components/seButton.js, line 188

Returns:

Type: void

set() → {void}

Source:

editor/components/seButton.js, line 204

Returns:

Type: void

set() → {void}

Source:

editor/components/seColorPicker.js, line 725

Returns:

Type: void

set() → {void}

Source:

editor/components/seColorPicker.js, line 741

Returns:

Type: void

set() → {void}

Source:

editor/components/seColorPicker.js, line 757

Returns:

Type: void

set() → {void}

Source:

editor/components/seExplorerButton.js, line 193

Returns:

Type: void

set() → {void}

Source:

editor/components/seExplorerButton.js, line 209

Returns:

Type: void

set() → {void}

Source:

editor/components/seExplorerButton.js, line 230

Returns:

Type: void

set() → {void}

Source:

editor/components/seFlyingButton.js, line 166

Returns:

Type: void

set() → {void}

Source:

editor/components/seFlyingButton.js, line 182

Returns:

Type: void

set() → {void}

Source:

editor/components/seFlyingButton.js, line 205

Returns:

Type: void

set() → {void}

Source:

editor/components/seFlyingButton.js, line 226

Returns:

Type: void

set() → {void}

Source:

editor/components/seInput.js, line 106

Returns:

Type: void

set() → {void}

Source:

editor/components/seInput.js, line 122

Returns:

Type: void

set() → {void}

Source:

editor/components/seInput.js, line 138

Returns:

Type: void

set() → {void}

Source:

editor/components/seInput.js, line 154

Returns:

Type: void

set() → {void}

Source:

editor/components/seInput.js, line 170

Returns:

Type: void

set() → {void}

Source:

editor/components/seList.js, line 116

Returns:

Type: void

set() → {void}

Source:

editor/components/seList.js, line 132

Returns:

Type: void

set() → {void}

Source:

editor/components/seList.js, line 148

Returns:

Type: void

set() → {void}

Source:

editor/components/seList.js, line 164

Returns:

Type: void

set() → {void}

Source:

editor/components/seListItem.js, line 87

Returns:

Type: void

set() → {void}

Source:

editor/components/seListItem.js, line 103

Returns:

Type: void

set() → {void}

Source:

editor/components/seListItem.js, line 119

Returns:

Type: void

set() → {void}

Source:

editor/components/seListItem.js, line 135

Returns:

Type: void

set() → {void}

Source:

editor/components/seMenu.js, line 92

Returns:

Type: void

set() → {void}

Source:

editor/components/seMenu.js, line 108

Returns:

Type: void

set() → {void}

Source:

editor/components/seMenuItem.js, line 77

Returns:

Type: void

set() → {void}

Source:

editor/components/seMenuItem.js, line 93

Returns:

Type: void

set() → {void}

Source:

editor/components/seSelect.js, line 116

Returns:

Type: void

set() → {void}

Source:

editor/components/seSelect.js, line 132

Returns:

Type: void

set() → {void}

Source:

editor/components/seSelect.js, line 148

Returns:

Type: void

set() → {void}

Source:

editor/components/seSelect.js, line 164

Returns:

Type: void

set() → {void}

Source:

editor/components/seSelect.js, line 180

Returns:

Type: void

set() → {void}

Source:

editor/components/seSpinInput.js, line 140

Returns:

Type: void

set() → {void}

Source:

editor/components/seSpinInput.js, line 156

Returns:

Type: void

set() → {void}

Source:

editor/components/seSpinInput.js, line 172

Returns:

Type: void

set() → {void}

Source:

editor/components/seSpinInput.js, line 188

Returns:

Type: void

set() → {void}

Source:

editor/components/seSpinInput.js, line 204

Returns:

Type: void

set() → {void}

Source:

editor/components/seText.js, line 77

Returns:

Type: void

set() → {void}

Source:

editor/components/seText.js, line 93

Returns:

Type: void

set() → {void}

Source:

editor/components/seText.js, line 109

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/cmenuDialog.js, line 152

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/cmenuDialog.js, line 168

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/cmenuDialog.js, line 184

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/cmenuLayersDialog.js, line 90

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/cmenuLayersDialog.js, line 106

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 195

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 211

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 227

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 243

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 259

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 275

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 291

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 307

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/editorPreferencesDialog.js, line 323

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/exportDialog.js, line 93

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/imagePropertiesDialog.js, line 186

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/imagePropertiesDialog.js, line 202

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/imagePropertiesDialog.js, line 218

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/imagePropertiesDialog.js, line 234

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/imagePropertiesDialog.js, line 250

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/imagePropertiesDialog.js, line 266

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 93

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 192

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/sePromptDialog.js, line 62

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/sePromptDialog.js, line 78

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/svgSourceDialog.js, line 111

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/svgSourceDialog.js, line 127

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/svgSourceDialog.js, line 143

Returns:

Type: void

set() → {void}

Source:

editor/dialogs/svgSourceDialog.js, line 159

Returns:

Type: void

set() → {void}

Source:

editor/extensions/ext-storage/storageDialog.js, line 118

Returns:

Type: void

setupCurConfig() → {void}

Sets up current config based on defaults.

Source:

editor/ConfigObj.js, line 224

Returns:

Type: void

setupCurPrefs() → {void}

Source:

editor/ConfigObj.js, line 210

Returns:

Type: void

src() → {string}

Source:

editor/components/seDropdown.js, line 119

Returns:

src

Type: string

src() → {void}

Source:

editor/components/seDropdown.js, line 127

Returns:

Type: void

src() → {void}

Source:

editor/components/seDropdown.js, line 143

Returns:

Type: void

src() → {string}

Source:

editor/components/seZoom.js, line 131

Returns:

src

Type: string

src() → {void}

Source:

editor/components/seZoom.js, line 139

Returns:

Type: void

src() → {void}

Source:

editor/components/seZoom.js, line 155

Returns:

Type: void

stateEffects(state, changed) → {any}

Parameters:

Name	Type	Description
`state`	any
`changed`	any

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 114

Returns:

Type: any

stepDown() → {void}

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 204

Returns:

Type: void

stepUp() → {void}

Source:

editor/dialogs/se-elix/src/base/NumberSpinBox.js, line 227

Returns:

Type: void

touchHandler(ev) → {void}

Parameters:

Name	Type	Description
`ev`	Event

Source:

svgcanvas/touch.js, line 7

Returns:

Type: void

updateLib(lib) → {void}

Parameters:

Name	Type	Description
`lib`	string

Source:

editor/components/seExplorerButton.js, line 289

Returns:

Type: void

value() → {string}

Source:

editor/components/seDropdown.js, line 151

Returns:

src

Type: string

value() → {void}

Source:

editor/components/seDropdown.js, line 159

Returns:

Type: void

value() → {string}

Source:

editor/components/seZoom.js, line 163

Returns:

src

Type: string

value() → {void}

Source:

editor/components/seZoom.js, line 171

Returns:

Type: void

Type Definitions

ArbitraryCallbackResult

This should only be used when the return result from a callback is not known as to type.

Type:

Source:

editor/typedefs.js, line 13

ArbitraryModule

Type:

object

Source:

editor/typedefs.js, line 31

ArbitraryObject

This should only be used for objects known to be potentially arbitrary in form. For those whose determination has not yet been made, simply use type object (or type ? if it may also be a primitive).

Type:

object

Source:

editor/typedefs.js, line 25

ArgumentsArray

This should only be used for arrays known to be potentially arbitrary in form and representing arguments for passing around.

Type:

GenericArray

Source:

editor/typedefs.js, line 48

Float

Type:

number

Source:

editor/typedefs.js, line 1

GenericArray

This should only be used for arrays known to be potentially arbitrary in form. For those whose determination has not yet been made, simply use type Array.

Type:

Array

Source:

editor/typedefs.js, line 42

GenericCallback(…args) → {ArbitraryCallbackResult}

Parameters:

Name	Type	Attributes	Description
`args`	any	<repeatable>	Signature dependent on the function

Source:

editor/typedefs.js, line 19

Returns:

Return dependent on the function

Type: ArbitraryCallbackResult

Integer

Type:

Float

Source:

editor/typedefs.js, line 5

JSON

Type:

null | boolean | Float | string | GenericArray | PlainObject

Source:

editor/typedefs.js, line 9

PlainObject

This should only be used for objects known to be potentially arbitrary in form, but not of a special type. For those whose determination has not yet been made, simply use type object.

Type:

ArbitraryObject

Source:

editor/typedefs.js, line 35