class anychart.graphics.vector.Element Improve this Doc

Abstract class for all vector elements, such as groups and primitives.
Due to the fact that this class is a child of from goog.events.EventTarget all its childs can work with events.
Never call a constructor directly!

Methods Overview

Events
listen()	Adds an event listener.
listenOnce()	Adds an event listener that is removed automatically after the listener fired once.
removeAllListeners()	Removes all listeners from this listenable.
unlisten()	Removes an event listener which was added with listen() or listenOnce().
unlistenByKey()	Removes an event listener which was added with listen() by the key returned by listen().
Interactive
drag()	Dragging setting.
Interactivity
visible()	Visibility flag
Size and Position
appendTransformationMatrix()	Combines the transformation with the given transformation matrix.
getAbsoluteBounds()	Gets element bounds in absolute coordinates (root element coordinate system).
getAbsoluteHeight()	Returns height within root bounds.
getAbsoluteWidth()	Returns width within root bounds.
getAbsoluteX()	Returns an absolute X (root element coordinate system).
getAbsoluteY()	Returns an absolute Y (root element coordinate system).
getBounds()	Returns the bounds.
getHeight()	Returns the height.
getRotationAngle()	Returns the rotation angle in degrees.
getTransformationMatrix()	Returns the transformation matrix.
getWidth()	Returns the width.
getX()	Returns X in the coordinate system of the parent.
getY()	Returns Y in the coordinate system of the parent.
rotate()	Rotates a shape around the given rotation point.
rotateByAnchor()	Rotates a shape around the given anchor.
scale()	Scales a shape. Scaling center is set in the coordinate system of the parent.
scaleByAnchor()	Scales a shape by anchor. Scaling center is set as an anchor.
setPosition()	Sets top left corner of a shape (transformation taken into account) in the coordinate system of the parent.
setRotation()	Rotates a shape around the given point.
setRotationByAnchor()	Rotates a shape around the given anchor.
setTransformationMatrix()	Sets the transformation matrix.
translate()	Moves a shape taking an account the transformation.
zIndex()	Z-index setting.
Miscellaneous
attr()	Attribute setting
clip()	Clipping setting.
cursor()	Cursor type.
desc()	Description setting
disablePointerEvents()	Pointer events setting.
disableStrokeScaling()	Vector effect property
dispose()	Disposes element completely.
domElement()	Returns DOM element if element is rendered.
getStage()	Stage object (to which the given element is bound).
hasParent()	Whether parent element is set.
id()	Element identifier
parent()	Parent layer.
remove()	Current element removes itself from the parent layer.
title()	Title setting

Methods Description

appendTransformationMatrix

appendTransformationMatrix(m00, m10, m01, m11, m02, m12)

Combines the transformation with the given transformation matrix.

Detailed description

Combination is done via matrix multiplication (multiplication to the right).
Illustration shows a shape transformation with the several calls of .appendTransformationMatrix(0, 0.5, 1, 0, 0, 0)

Params:

Name	Type	Description
m00	number	Scale X.
m10	number	Shear Y.
m01	number	Shear X.
m11	number	Scale Y.
m02	number	Translate X.
m12	number	Translate Y.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

attr

attr(key)Since version 7.11.0

Getter for the attribute.

Params:

Name	Type	Description
key	string	Name of attribute.

Returns:

* - Attribute value.

Try it:

Usage sample

attr(key, value)Since version 7.11.0

Setter for the attribute.

Params:

Name	Type	Description
key	string	Name of attribute.
value	*	Value of attribute.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

clip

clip()

Gets the clipping rectangle.

Returns:

anychart.graphics.math.Rect - Returns rectangle settings.

clip(value)

Sets the clipping rectangle.

Detailed description

Affects display only after render() method call.
Attention! In SVG clip will transform according to transformation, and in VML clip will be surrounding.

Params:

Name	Type	Description
value	anychart.graphics.math.Rect \| string	Clipping rectangle.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

cursor

cursor()

Getter for the cursor type.

Returns:

anychart.graphics.vector.Cursor - Returns cursor type.

Try it:

Usage sample

cursor(value)

Setter for the cursor type.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Cursor	null	Cursor type.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

desc

desc()Since version 7.11.0

Getter for the element description value.

Returns:

string | null | undefined - The element description value.

Try it:

Usage sample

desc(value)Since version 7.11.0

Setter for the element description value.

Params:

Name	Type	Description
value	string \| null	Value to set.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

disablePointerEvents

disablePointerEvents()

Gets the value of the pointer events.

Returns:

boolean - Returns property value.

Try it:

Usage sample

disablePointerEvents(value)

Disables the pointer events.

Detailed description

Specifies under what circumstances a given graphics element can be a target element for a pointer event.

Params:

Name	Type	Default	Description
value	boolean	false	Pointer events property value.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

disableStrokeScaling

disableStrokeScaling()

Getter for the element's vector effect property.

Returns:

boolean - The vector effect property.

See listing

var element = stage.rect(10, 10, 100, 40);
var disableStrokeScaling = element.disableStrokeScaling();

disableStrokeScaling(enabled)

Setter for the element's vector effect property.
Learn more by link.

Params:

Name	Type	Default	Description
enabled	boolean	false	Vector effect property to set.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

dispose

dispose()

Disposes element completely. Removes it from the parent layer, sets links to null, removes it from DOM.

Try it:

Usage sample

domElement

domElement()

Returns DOM element if element is rendered.
In case of Stage in Suspended state or unbound element - null is returned.

Returns:

Element - DOM element.

drag

drag()

Returns the state flag.

Returns:

boolean | anychart.graphics.math.Rect - Absolute element bounds or flag.

Try it:

Usage sample

drag(value)

Turns off/on dragging (moving) of an element.

Detailed description

Sets mode (true - on, false - off) or dragging area for an element, dragging is always on within an area.

Params:

Name	Type	Default	Description
value	boolean \| anychart.graphics.math.Rect	false	Flag or a dragging area.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

getAbsoluteBounds

getAbsoluteBounds()

Gets element bounds in absolute coordinates (root element coordinate system).

Detailed description

Returns:

anychart.graphics.math.Rect - Absolute element bounds.

Try it:

Usage sample

getAbsoluteHeight

getAbsoluteHeight()

Returns height within root bounds.
See illustrations at anychart.graphics.vector.Element#getAbsoluteWidth

Returns:

number - Height.

Try it:

Usage sample

getAbsoluteWidth

getAbsoluteWidth()

Returns width within root bounds.

Detailed description

Returns:

number - Width.

Try it:

Usage sample

getAbsoluteX

getAbsoluteX()

Returns an absolute X (root element coordinate system).

Detailed description

Returns:

number - Absolute X.

Try it:

Usage sample

getAbsoluteY

getAbsoluteY()

Returns an absolute Y (root element coordinate system).

Detailed description

Returns:

number - Absolute Y.

Try it:

Usage sample

getBounds

getBounds()

Returns the bounds.

Returns:

anychart.graphics.math.Rect - Bounds.

Try it:

Usage sample

getHeight

getHeight()

Returns the height.

Returns:

number - Height.

Try it:

Usage sample

getRotationAngle

getRotationAngle()

Returns the rotation angle in degrees.

Returns:

number - Rotation angle.

Try it:

Usage sample

getStage

getStage()

Stage object (to which the given element is bound).

Returns:

anychart.graphics.vector.Stage - Stage object.

Try it:

Usage sample

getTransformationMatrix

getTransformationMatrix()

Returns the transformation matrix.

Detailed description

Matrix as an array of six elements:
[
  {number} m00 Scale X.
  {number} m10 Shear Y.
  {number} m01 Shear X.
  {number} m11 Scale Y.
  {number} m02 Translate X.
  {number} m12 Translate Y.
]

Returns:

Array.<number> - Transformation matrix array.

Try it:

Usage sample

getWidth

getWidth()

Returns the width.

Returns:

number - Width.

Try it:

Usage sample

getX

getX()

Returns X in the coordinate system of the parent.

Returns:

number - X in the coordinate system of the parent.

Try it:

Usage sample

getY

getY()

Returns Y in the coordinate system of the parent.

Returns:

number - Y in the coordinate system of the parent.

Try it:

Usage sample

hasParent

hasParent()

Whether parent element is set.

Returns:

boolean - Whether parent element is set.

Try it:

Usage sample

id

id()

Gets the element identifier.

Detailed description

If it was not set, it will be generated and applied to the DOM.

Returns:

string - Returns element identifier.

Try it:

Usage sample

id(id)

Sets the element identifier.

Params:

Name	Type	Description
id	string	Custom identifier.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener.

Detailed description

A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object):boolean\|undefined		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener that is removed automatically after the listener fired once.

Detailed description

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object):boolean\|undefined		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

parent

parent()

Returns the parent layer.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - Instance of element current layer.

Try it:

Usage sample

parent(parent)

Adds element to the given layer.

Params:

Name	Type	Description
parent	anychart.graphics.vector.Layer \| anychart.graphics.vector.Stage	Parent layer.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

remove

remove()

Current element removes itself from the parent layer.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from this listenable.

Detailed description

If type is specified, it will only remove listeners of the particular type. otherwise all registered listeners will be removed.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

rotate

rotate(degrees, cx, cy)

Rotates a shape around the given rotation point.

Detailed description

If rotation point is not set then rotation point is (0, 0).
Left illustration shows 20 degrees rotation with the default rotation point.
.rotate(20)
Right illustration shows 20 degrees rotation with the given rotation point.
.rotate(20, x, y)
Rotation points are marked with red, initial position of shapes is marked with gray.

Params:

Name	Type	Description
degrees	number	Rotation angle in degrees.
cx	number	Rotation point X.
cy	number	Rotation point Y.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

rotateByAnchor

rotateByAnchor(degrees, anchor)

Rotates a shape around the given anchor.

Detailed description

If anchor is not set anychart.graphics.vector.Anchor.CENTER is the default.
Left illustration shows 90 degrees rotation around the default anchor.
.rotateByAnchor(90)
Right illustration shows 90 degrees rotation around the given anchor.
.rotateByAnchor(90, anychart.graphics.vector.Anchor.CENTER_TOP)
Rotation points are marked with red, initial position of shapes is marked with gray.

Params:

Name	Type	Description
degrees	number	Rotation angle in degrees.
anchor	anychart.graphics.vector.Anchor \| string	Rotation anchor.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

scale

scale(sx, sy, cx, cy)

Scales a shape. Scaling center is set in the coordinate system of the parent.

Detailed description

If the scaling center is not set it defaults to (0, 0).
Left illustration shows default point scaling.
.scale(0.5, 0.5,)
Right illustration shows scaling with the scaling center set.
.scale(0.5, 0.5, x, y)
Scaling center is marked with red, initial state is marked with gray.

Params:

Name	Type	Description
sx	number	X scaling factor.
sy	number	Y scaling factor.
cx	number	Scaling point X.
cy	number	Scaling point Y.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

scaleByAnchor

scaleByAnchor(sx, sy, anchor)

Scales a shape by anchor. Scaling center is set as an anchor.

Detailed description

If anchor is not set it defaults to anychart.graphics.vector.Anchor.CENTER.
Left illustration shows scaling with the default anchor.
.scaleByAnchor(0.5, 0.5)
Right illustration shows scaling with the anchor set.
.scaleByAnchor(0.5, 0.5, anychart.graphics.vector.Anchor.RIGHT_TOP)
Scaling center is marked with red, initial state is marked with gray.

Params:

Name	Type	Description
sx	number	X scaling factor.
sy	number	Y scaling factor.
anchor	anychart.graphics.vector.Anchor \| string	Scaling anchor point.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

setPosition

setPosition(x, y)

Sets top left corner of a shape (transformation taken into account) in the coordinate system of the parent.

Detailed description

Note: See illustration at anychart.graphics.vector.Element#translate, the only difference between anychart.graphics.vector.Element#translate and this method is the fact that that this method resets the current transformation, and anychart.graphics.vector.Element#translate adds movement to the existing transformation.

Params:

Name	Type	Description
x	number	X coordinate.
y	number	Y coordinate.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

setRotation

setRotation(degrees, cx, cy)

Rotates a shape around the given point.

Detailed description

Note: See illustration at anychart.graphics.vector.Element#rotate, the only difference between anychart.graphics.vector.Element#rotate and this method is the fact that this method resets the current transformation, and anychart.graphics.vector.Element#rotate adds rotation to the existing transformation.

Params:

Name	Type	Description
degrees	number	Rotation angle in degrees.
cx	number	Rotation point X.
cy	number	Rotation point Y.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

setRotationByAnchor

setRotationByAnchor(degrees, anchor)

Rotates a shape around the given anchor.

Detailed description

Note: See illustration at anychart.graphics.vector.Element#rotateByAnchor, the only difference between anychart.graphics.vector.Element#rotateByAnchor and this method is the fact that this method resets the current transformation, and anychart.graphics.vector.Element#rotate adds rotation to the existing transformation.

Params:

Name	Type	Description
degrees	number	Rotation angle in degrees.
anchor	anychart.graphics.vector.Anchor \| string	Rotation anchor.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

setTransformationMatrix

setTransformationMatrix(m00, m10, m01, m11, m02, m12)

Sets the transformation matrix.

Detailed description

Note: See illustration at anychart.graphics.vector.Element#appendTransformationMatrix, the difference between anychart.graphics.vector.Element#appendTransformationMatrix and this method is that anychart.graphics.vector.Element#appendTransformationMatrix combined transformation with the current, and this method resets the current.

Params:

Name	Type	Description
m00	number	Scale X.
m10	number	Shear Y.
m01	number	Shear X.
m11	number	Scale Y.
m02	number	Translate X.
m12	number	Translate Y.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

title

title()Since version 7.11.0

Getter for the element title value.

Returns:

string | null | undefined - The element title value.

Try it:

Usage sample

title(value)Since version 7.11.0

Setter for the element title value.

Params:

Name	Type	Description
value	string \| null	Value to set.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

translate

translate(tx, ty)

Moves a shape taking an account the transformation.

Detailed description

Movement happens in a shape coordinate system (not the coordinate system of the parent).
Illustration shows a shape movement when .translate(20, 10) is invoked several times.

Params:

Name	Type	Description
tx	number	X movement amount.
ty	number	Y movement amount.

Returns:

anychart.graphics.vector.Element - Self instance for method chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes an event listener which was added with listen() or listenOnce().

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object):boolean\|undefined		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.