JSDoc: Namespace: pathActions

Group: Path edit functions Functions relating to editing path elements

Source:

path.js, line 1700

Methods

(static) addSubPath(on) → {void}

Parameters:

Name	Type	Description
`on`	boolean

Source:

path.js, line 2271

Returns:

Type: void

(static) clear(remove) → {void}

Parameters:

Name	Type	Description
`remove`	boolean	Not in use

Source:

path.js, line 2329

Returns:

Type: void

(static) clonePathNode() → {void}

Source:

path.js, line 2425

Returns:

Type: void

(static) convertPath()

Convert a path to one with only absolute or relative values

Source:

path.js, line 2704

See:

module:path.convertPath

(static) deletePathNode() → {void}

Source:

path.js, line 2560

Returns:

Type: void

(static) fixEnd(elem) → {void}

Parameters:

Name	Type	Description
`elem`	Element

Source:

path.js, line 2676

Returns:

Type: void

(static) getNodePoint() → {module:path.NodePoint}

Source:

path.js, line 2405

Returns:

Type: module:path.NodePoint

(static) linkControlPoints(linkPoints) → {void}

Parameters:

Name	Type	Description
`linkPoints`	boolean

Source:

path.js, line 2419

Returns:

Type: void

(static) mouseDown(evt, mouseTarget, startX, startY) → {boolean|void}

Parameters:

Name	Type	Description
`evt`	MouseEvent
`mouseTarget`	Element
`startX`	Float
`startY`	Float

Source:

path.js, line 1799

Returns:

Type: boolean | void

(static) mouseMove(mouseX, mouseY) → {void}

Parameters:

Name	Type	Description
`mouseX`	Float
`mouseY`	Float

Source:

path.js, line 2049

Returns:

Type: void

(static) mouseUp(evt, element, mouseX, mouseY) → {module:path.keepElement|void}

Parameters:

Name	Type	Description
`evt`	Event
`element`	Element
`mouseX`	Float
`mouseY`	Float

Source:

path.js, line 2185

Returns:

Type: module:path.keepElement | void

(static) moveNode(attr, newValue) → {void}

Parameters:

Name	Type	Description
`attr`	string
`newValue`	Float

Source:

path.js, line 2658

Returns:

Type: void

(static) opencloseSubPath() → {void}

Source:

path.js, line 2448

Returns:

Type: void

(static) reorient() → {void}

Source:

path.js, line 2299

Fires:

module:svgcanvas.SvgCanvas#event:changed

Returns:

Type: void

(static) resetOrientation(pthnullable) → {false|void}

Parameters:

Name	Type	Attributes	Description
`pth`	Element \| SVGPathElement	<nullable>

Source:

path.js, line 2349

Returns:

Type: false | void

(static) select(target) → {void}

Parameters:

Name	Type	Description
`target`	Element

Source:

path.js, line 2286

Returns:

Type: void

(static) setSegType(vnullable) → {void}

Parameters:

Name	Type	Attributes	Description
`v`	Integer	<nullable>	See https://www.w3.org/TR/SVG/single-page.html#paths-InterfaceSVGPathSeg

Source:

path.js, line 2650

Returns:

Type: void

(static) smoothPolylineIntoPath()

Smooth polyline into path

Source:

path.js, line 2640

See:

module:path~smoothPolylineIntoPath

(static) toEditMode(element) → {void}

Parameters:

Name	Type	Description
`element`	Element

Source:

path.js, line 2237

Returns:

Type: void

(static) toSelectMode(elem) → {void}

Parameters:

Name	Type	Description
`elem`	Element

Source:

path.js, line 2250

Fires:

module:svgcanvas.SvgCanvas#event:selected

Returns:

Type: void

(static) zoomChange() → {void}

Source:

path.js, line 2391

Returns:

Type: void