JSDoc: Class: SVGResizableRect

Constructor

new SVGResizableRect(optsopt)

Creates svgext.SVGResizableRect instance

Parameters:

Name	Type	Attributes	Description
`opts`	rectOpts	<optional>

Mixes In:

svgext.SVGBlock

Source:

resizable-rect/svg-resizable-rect.js, line 29

Extends

svgext.SVGRect

Members

(constant) NS :String

SVG namespace

Type:

String

Inherited From:

svgext.SVGElement#NS

Default Value:

http://www.w3.org/2000/svg

Source:

svg-element.js, line 13

Methods

activate() → {SVGElement}

Adds an active class

Overrides:

svgext.SVGRect#activate

Source:

svg-element.js, line 152

Fires:

svgext.SVGElement#event:activated

Returns:

Type: SVGElement

addClass(newClass) → {SVGElement}

Adds a new class to the element

Parameters:

Name	Type	Description
`newClass`	String	Class name or several classes separated by a space

Inherited From:

svgext.SVGElement#addClass

Source:

svg-element.js, line 68

Returns:

Type: SVGElement

append(svgElem) → {SVGBlock}

Appends an element

Parameters:

Name	Type	Description
`svgElem`	SVGElement

Mixes In:

svgext.SVGBlock.append

Source:

svg-block.js, line 28

Returns:

Type: SVGBlock

appendElem(node)

Appends svg node

Parameters:

Name	Type	Description
`node`	SVGNode

Mixes In:

svgext.SVGBlock.appendElem

Source:

svg-block.js, line 42

attr(key, valueopt) → {SVGElement}

SVGElement node attributes setter & getter

Parameters:

Name	Type	Attributes	Description
`key`	String
`value`	String	<optional>

Inherited From:

svgext.SVGElement#attr

Source:

svg-element.js, line 121

Fires:

svgext.SVGElement#event:change[ATTR_NAME]

Returns:

Type: SVGElement

bringToFront() → {SVGElement}

Brings an element above another

Inherited From:

svgext.SVGElement#bringToFront

Source:

svg-element.js, line 137

Returns:

Type: SVGElement

deactivate() → {SVGElement}

Removes an active class

Overrides:

svgext.SVGRect#deactivate

Source:

svg-element.js, line 166

Fires:

svgext.SVGElement#event:deactivated

Returns:

Type: SVGElement

destroy()

Destroys an object

Inherited From:

svgext.SVGElement#destroy

Source:

svg-element.js, line 273

drag(delta)

Changes element position on mouse move

Parameters:

Name	Type	Description
`delta`	coordinates

Overrides:

svgext.SVGRect#drag

Mixes In:

svgext.SVGDraggable.drag

Source:

svg-draggable.js, line 141

emit(type, …arguments)

Emits custom event on the element

Parameters:

Name	Type	Attributes	Description
`type`	String
`arguments`	*	<repeatable>

Inherited From:

svgext.SVGElement#emit

Source:

svg-element.js, line 196

getContainerRect() → {TextRectangle}

Svg container bounding client rect getter

Inherited From:

svgext.SVGElement#getContainerRect

Source:

svg-element.js, line 257

Returns:

Type: TextRectangle

getRect() → {TextRectangle}

Element bounding client rect getter

Inherited From:

svgext.SVGElement#getRect

Source:

svg-element.js, line 266

Returns:

Type: TextRectangle

getValue(relativeopt) → {resolution}

Rectangle value getter

Parameters:

Name	Type	Attributes	Default	Description
`relative`	Boolean	<optional>	false	Returns relative coordinates if true

Inherited From:

svgext.SVGRect#getValue

Source:

svg-rect.js, line 163

Returns:

Type: resolution

getX() → {Number}

Rectangle X coordinate getter

Inherited From:

svgext.SVGRect#getX

Source:

svg-rect.js, line 77

Returns:

Type: Number

getY() → {Number}

Rectangle Y coordinate getter

Inherited From:

svgext.SVGRect#getY

Source:

svg-rect.js, line 98

Returns:

Type: Number

hasClass(className) → {Boolean}

Checks if instance has a class

Parameters:

Name	Type	Description
`className`	String

Inherited From:

svgext.SVGElement#hasClass

Source:

svg-element.js, line 53

Returns:

Type: Boolean

height(heightopt) → {Number|SVGRect}

Sets or gets rectangle height

Parameters:

Name	Type	Attributes	Description
`height`	Number	<optional>

Inherited From:

svgext.SVGRect#height

Source:

svg-rect.js, line 123

Returns:

Type: Number | SVGRect

hide() → {SVGElement}

Hides an elment

Overrides:

svgext.SVGRect#hide

Source:

svg-element.js, line 100

Returns:

Type: SVGElement

normalizeCoords(delta) → {coordinates}

Checks if a new element position won't cross the border and changes delta object to avoid border crossing

Parameters:

Name	Type	Description
`delta`	coordinates

Inherited From:

svgext.SVGRect#normalizeCoords

Mixes In:

svgext.SVGDraggable.normalizeCoords

Source:

svg-draggable.js, line 153

Returns:

Type: coordinates

off(type, listener) → {SVGElement}

Removes an event listener

Parameters:

Name	Type	Description
`type`	String	Event name
`listener`	function	Event handler

Inherited From:

svgext.SVGElement#off

Source:

svg-element.js, line 242

Returns:

Type: SVGElement

offDoubleTap(tap) → {SVGElement}

Removes double tap event handler

Parameters:

Name	Type	Description
`tap`	function

Inherited From:

svgext.SVGElement#offDoubleTap

Source:

svg-element.js, line 231

Returns:

Type: SVGElement

on(type, listener) → {SVGElement}

Adds an event listener

Parameters:

Name	Type	Description
`type`	String	Event name
`listener`	function	Event handler

Inherited From:

svgext.SVGElement#on

Source:

svg-element.js, line 180

Returns:

Type: SVGElement

onAppend(container)

Fires when an element is appended to the DOM

Parameters:

Name	Type	Description
`container`	SVGBlock	New element container

Inherited From:

svgext.SVGElement#onAppend

Source:

svg-element.js, line 295

onDoubleTap(listener) → {function}

Adds double tap event handler

Parameters:

Name	Type	Description
`listener`	function

Inherited From:

svgext.SVGElement#onDoubleTap

Source:

svg-element.js, line 206

Returns:

Type: function

remove(svgElem) → {SVGBlock}

Removes an svg element

Parameters:

Name	Type	Description
`svgElem`	SVGElement

Mixes In:

svgext.SVGBlock.remove

Source:

svg-block.js, line 52

Returns:

Type: SVGBlock

removeClass(className) → {SVGElement}

Removes class

Parameters:

Name	Type	Description
`className`	String

Inherited From:

svgext.SVGElement#removeClass

Source:

svg-element.js, line 85

Returns:

Type: SVGElement

removeDndHandlers()

Removes all handlers

Inherited From:

svgext.SVGRect#removeDndHandlers

Mixes In:

svgext.SVGDraggable.removeDndHandlers

Source:

svg-draggable.js, line 43

removeElem(node)

Removes svg node

Parameters:

Name	Type	Description
`node`	SVGNode

Mixes In:

svgext.SVGBlock.removeElem

Source:

svg-block.js, line 73

resize(widthFactor, heightFactor)

Resizes rectangle

Parameters:

Name	Type	Description
`widthFactor`	Number	width resize factor
`heightFactor`	Number	height resize factor

Source:

resizable-rect/svg-resizable-rect.js, line 133

select() → {SVGResizableRect}

Activates rectangle

Source:

resizable-rect/svg-resizable-rect.js, line 121

Returns:

Type: SVGResizableRect

setX(x) → {SVGRect}

Rectangle X coordinate setter

Parameters:

Name	Type	Description
`x`	Number

Inherited From:

svgext.SVGRect#setX

Source:

svg-rect.js, line 67

Returns:

Type: SVGRect

setY(y) → {SVGRectangle}

Rectangle Y coordinate setter

Parameters:

Name	Type	Description
`y`	Number

Inherited From:

svgext.SVGRect#setY

Source:

svg-rect.js, line 87

Returns:

Type: SVGRectangle

show() → {SVGElement}

Shows an elment

Overrides:

svgext.SVGRect#show

Source:

svg-element.js, line 109

Returns:

Type: SVGElement

update(type)

Changes rectangle coordiantes or resolution after controls move

Parameters:

Name	Type	Description
`type`	'vertical' \| 'horizontal'	Control type

Source:

resizable-rect/svg-resizable-rect.js, line 48

width(widthopt) → {Number|SVGRect}

Sets or gets rectangle width

Parameters:

Name	Type	Attributes	Description
`width`	Number	<optional>

Inherited From:

svgext.SVGRect#width

Source:

svg-rect.js, line 108

Returns:

Type: Number | SVGRect