JSDoc: Class: Editor

new Editor()

Source:

editor/Editor.js, line 36

Members

langChanged :boolean

Type:

boolean

Source:

editor/Editor.js, line 45

showSaveWarning :boolean

Type:

boolean

Source:

editor/Editor.js, line 49

storagePromptState :"ignore"|"waiting"|"closed"

Will be set to a boolean by ext-storage.js

Type:

"ignore" | "waiting" | "closed"

Source:

editor/Editor.js, line 54

title

document title

Source:

editor/Editor.js, line 58

Methods

afterClear() → {void}

Source:

editor/Editor.js, line 595

Returns:

Type: void

beforeClear() → {void}

Source:

editor/Editor.js, line 604

Returns:

Type: void

cancelOverlays(e) → {void}

Parameters:

Name	Type	Description
`e`	Event

Source:

editor/Editor.js, line 919

Returns:

Resolves to undefined

Type: void

contextChanged(win, context) → {void}

Parameters:

Name	Type	Description
`win`	external:Window
`context`	module:svgcanvas.SvgCanvas#event:contextset

Source:

editor/Editor.js, line 683

Listens to Events:

module:svgcanvas.SvgCanvas#event:contextset

Returns:

Type: void

cutSelected() → {void}

Source:

editor/Editor.js, line 779

Returns:

Type: void

elementChanged(win, elems) → {void}

Parameters:

Name	Type	Description
`win`	external:Window
`elems`	Array.<PlainObject>

Source:

editor/Editor.js, line 535

Fires:

module:svgcanvas.SvgCanvas#event:ext_elementChanged

Listens to Events:

module:svgcanvas.SvgCanvas#event:changed

Returns:

Type: void

elementRenamed() → {void}

Source:

editor/Editor.js, line 583

Returns:

Type: void

elementTransition(win, elems) → {void}

Parameters:

Name	Type	Description
`win`	external:Window
`elems`	module:svgcanvas.SvgCanvas#event:transition

Source:

editor/Editor.js, line 497

Fires:

module:svgcanvas.SvgCanvas#event:ext_elementTransition

Listens to Events:

module:svgcanvas.SvgCanvas#event:transition

Returns:

Type: void

enableOrDisableClipboard() → {void}

Source:

editor/Editor.js, line 948

Returns:

Type: void

exportHandler(win, data) → {void}

Parameters:

Name	Type	Description
`win`	external:Window
`data`	module:svgcanvas.SvgCanvas#event:exported

Source:

editor/Editor.js, line 293

Listens to Events:

module:svgcanvas.SvgCanvas#event:exported

Returns:

Type: void

(async) extAdded(win, ext) → {Promise.<void>|void}

Parameters:

Name	Type	Description
`win`	external:Window
`ext`	module:svgcanvas.SvgCanvas#event:extension_added

Source:

editor/Editor.js, line 738

Listens to Events:

module:svgcanvas.SvgCanvas#event:extension_added

Returns:

Resolves to undefined

Type: Promise.<void> | void

getButtonData(sel) → {module:SVGthis.ToolButton}

Parameters:

Name	Type	Description
`sel`	string	Selector to match

Source:

editor/Editor.js, line 281

Returns:

Type: module:SVGthis.ToolButton

hideSourceEditor() → {void}

Source:

editor/Editor.js, line 882

Returns:

Type: void

loadSvgString(str, optsopt) → {void}

Parameters:

Name Type Attributes Default Description

str

string

SVG string

opts

PlainObject

{}

Properties

Name	Type	Attributes	Description
`noAlert`	boolean	<optional>

Source:

editor/Editor.js, line 135

Throws:

Upon failure to load SVG
Type Error

Returns:

Type: void

moveSelected(dx, dy) → {void}

Parameters:

Name	Type	Description
`dx`	Float
`dy`	Float

Source:

editor/Editor.js, line 832

Returns:

Type: void

moveUpDownSelected(dir) → {void}

Parameters:

Name	Type	Description
`dir`	"Up" \| "Down"

Source:

editor/Editor.js, line 821

Returns:

Type: void

onDragEnter(e) → {void}

Parameters:

Name	Type	Description
`e`	Event

Source:

editor/Editor.js, line 978

Returns:

Type: void

onDragLeave(e) → {void}

Parameters:

Name	Type	Description
`e`	Event

Source:

editor/Editor.js, line 999

Returns:

Type: void

onDragOver(e) → {void}

Parameters:

Name	Type	Description
`e`	Event

Source:

editor/Editor.js, line 989

Returns:

Type: void

pasteInCenter() → {void}

Source:

editor/Editor.js, line 799

Returns:

Type: void

rotateSelected(cw, step) → {void}

Parameters:

Name	Type	Description
`cw`	0 \| 1
`step`	Integer

Source:

editor/Editor.js, line 866

Returns:

Type: void

(async) saveSourceEditor(e) → {void}

Parameters:

Name	Type	Description
`e`	Event

Source:

editor/Editor.js, line 891

Returns:

Resolves to undefined

Type: void

selectedChanged(win, elems) → {void}

Parameters:

Name	Type	Description
`win`	external:Window
`elems`	module:svgcanvas.SvgCanvas#event:selected	Array of elements that were selected

Source:

editor/Editor.js, line 462

Fires:

module:svgcanvas.SvgCanvas#event:ext_selectedChanged

Listens to Events:

module:svgcanvas.SvgCanvas#event:selected

Returns:

Type: void

selectNext() → {void}

Source:

editor/Editor.js, line 849

Returns:

Type: void

selectPrev() → {void}

Source:

editor/Editor.js, line 857

Returns:

Type: void

setAll() → {void}

Source:

editor/Editor.js, line 201

Returns:

Type: void

setBackground(color, url) → {void}

Parameters:

Name	Type	Description
`color`	string
`url`	string

Source:

editor/Editor.js, line 333

Returns:

Type: void

updateWireFrame() → {void}

Source:

editor/Editor.js, line 440

Returns:

Type: void

zoomDone() → {void}

Source:

editor/Editor.js, line 613

Returns:

Type: void

zoomImage(multiplier) → {void}

Parameters:

Name	Type	Description
`multiplier`	Float

Source:

editor/Editor.js, line 765

Returns:

Type: void