AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.8.0 version of this document. Switch to the 8.3.0 version to see the up to date information.

class anychart.graphics.vector.Shape Improve this Doc

Extends: anychart.graphics.vector.Element

Base class for all vector elements.
Never invoke constructor directly!

Methods Overview

Miscellaneous
appendTransformationMatrix()Combines the current transformation with the given transformation matrix.
clip()Sets clipping rectangle.
cursor()Getter for cursor type.
disablePointerEvents()Specifies under what circumstances a given graphics element can be a target element for a pointer event.
domElement()Returns DOM element if element is rendered.
drag()Turns off/on dragging (moving) of an element.
fill()Sets fill as object or string.
getAbsoluteBounds()Gets element bounds in absolute coordinates (root element coordinate system).
getAbsoluteCoordinate()Returns absolute coordinates (root element coordinate system).
getAbsoluteHeight()Returns height within root bounds.
getAbsoluteSize()Returns size 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 bounds.
getCoordinate()Returns (X,Y) in the coordinate system of the parent.
getHeight()Returns height.
getRotationAngle()Returns the current rotation angle in degrees.
getSize()Returns size.
getStage()Stage object (to which the given element is bound).
getTransformationMatrix()Returns the current transformation matrix.
getWidth()Returns width.
getX()Returns X in the coordinate system of the parent.
getY()Returns Y in the coordinate system of the parent.
hasParent()Whether parent element is set.
id()Gets element identifier. If it was not set, it will be generated and applied to the DOM.
listen()Adds an event listener. A listener can only be added once to an
listenOnce()Adds an event listener that is removed automatically after the
parent()Returns the parent layer.
remove()Current element removes itself from the parent layer.
removeAllListeners()Removes all listeners from this listenable. If type is specified,
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. 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()Rotatates a shape around the given point.
setRotationByAnchor()Rotates a shape around the given anchor.
setTransformationMatrix()Sets transformation matrix.
stroke()Sets stroke using one parameter.
strokeThickness()Gets stroke thickness.
translate()Moves a shape taking an account the current transformation.
unlisten()Removes an event listener which was added with listen() or listenOnce().
visible()Gets/sets the current visibility flag.
zIndex()Gets and sets element's zIndex.

Methods Description

appendTransformationMatrix

Combines the current transformation with the given transformation matrix. Combination is done via matrix multiplication (multiplication to the right).

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.

clip

Gets/sets clipping rectangle.

Returns:

anychart.graphics.math.Rect - An instance of class for method chaining.
Sets clipping rectangle. 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.

cursor

Getter for cursor type.

Returns:

anychart.graphics.vector.Cursor - Current cursor type.
Setter for cursor type.

Params:

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

Returns:

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

disablePointerEvents

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

Params:

Name Type Description
value boolean Pointer events property value.

Returns:

anychart.graphics.vector.Element boolean - If opt_value defined then returns Element object for chaining else returns property value.

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

Returns current state flag.

Returns:

boolean anychart.graphics.math.Rect - .
Turns off/on dragging (moving) of an element.
Sets mode (true - on, false - off) or dragging area for an element, dragging is always on within an area.

Params:

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

Returns:

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

Try it:

fill

Returns fill.

Returns:

anychart.graphics.vector.Fill - Current fill (empty fill is 'none').

Try it:

Sets fill as an object or a string.
Supported objects: Or a color as string. Can be combined with opacity: 'Color Opacity', 'red .5').

Params:

Name Type Description
value anychart.graphics.vector.Fill Fill as object or string.

Returns:

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

Try it:

Fill as string.
If color is set as string, like 'red .5', it has prioruty over opt_opacity, which means if fill is set as rect.fill('red 0.3', 0.7), opacity will be 0.3.

Params:

Name Type Description
color string Color as string.
opacity number Opacity.

Returns:

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

Try it:

Linear gradient fill.
Three modes are available:
  • ObjectBoundingBox with angle value preservation
  • ObjectBoundingBox without angle value preservation
  • UserSpaceOnUse

Modes:

ObjectBoundingBox without angle value preservation In this mode the result angle will visually correspond the original setting, non regarding browser scaling duplication (so, for objects that do not have 1:1 proportion with the original figure, the gradient angle will correspond to the initial value due to internal calculations). ObjectBoundingBox with angle value preservation In this mode, gradient vector is calculated with the preset angle, but the result gradient angle on the rendered page can be changed if the object proportion is not 1:1 in the browser. So visually the result gradient angle may not correspond to the original settings. UserSpaceOnUse In this mode gradient settings are added by gradient size and borders/coordinates, and rendering is calculated within those borders. After that, the fill is executed on the element figure according to its coordinates. More about this mode at gradientUnits.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

getAbsoluteBounds

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

Returns:

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

getAbsoluteCoordinate

Returns absolute coordinates (root element coordinate system).
See illustrations at anychart.graphics.vector.Element#getAbsoluteX and anychart.graphics.vector.Element#getAbsoluteY

Returns:

anychart.graphics.math.Coordinate - Absolute coordinates.

getAbsoluteHeight

Returns height within root bounds.

Returns:

number - Height.

getAbsoluteWidth

Returns width within root bounds.

Returns:

number - Width.

getAbsoluteX

Returns an absolute X (root element coordinate system).

Returns:

number - Absolute X.

getAbsoluteY

Returns an absolute Y (root element coordinate system).

Returns:

number - Absolute Y.

getBounds

Returns bounds.

Returns:

anychart.graphics.math.Rect - Bounds.

getCoordinate

Returns (X,Y) in the coordinate system of the parent.

Returns:

anychart.graphics.math.Coordinate - (X,Y) in the coordinate system of the parent.

getHeight

Returns height.

Returns:

number - Height.

getRotationAngle

Returns the current rotation angle in degrees.

Returns:

number - Rotation angle.

getSize

Returns size.

Returns:

anychart.graphics.math.Size - Size.

getStage

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

Returns:

anychart.graphics.vector.Stage - Stage object.

getTransformationMatrix

Returns the current transformation 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.

getWidth

Returns width.

Returns:

number - Width.

getX

Returns X in the coordinate system of the parent.

Returns:

number - X in the coordinate system of the parent.

getY

Returns Y in the coordinate system of the parent.

Returns:

number - Y in the coordinate system of the parent.

hasParent

Whether parent element is set.

Returns:

boolean - Whether parent element is set.

id

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

Returns:

string - Returns element identifier.
Sets element identifier.

Params:

Name Type Description
value string Custom identifier.

Returns:

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

listen

Adds an event listener. 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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope SCOPE Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener that is removed automatically after the listener fired once. 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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope SCOPE Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

parent

Returns the parent layer.

Returns:

anychart.graphics.vector.Layer anychart.graphics.vector.Stage - Instance of element current layer.
Adds element to the given layer.

Params:

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

Returns:

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

remove

Current element removes itself from the parent layer.

Returns:

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

removeAllListeners

Removes all listeners from this listenable. 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.

rotate

Rotates a shape around the given rotation point.

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.

rotateByAnchor

Rotates a shape around the given anchor.

Params:

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

Returns:

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

scale

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

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.

scaleByAnchor

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

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.

setPosition

Sets top left corner of a shape (transformation taken into account) in the coordinate system of the parent.
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 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.

setRotation

Rotates a shape around the given point.
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.

setRotationByAnchor

Rotates a shape around the given anchor.
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 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.

setTransformationMatrix

Sets transformation matrix.
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.

stroke

Returns stroke.

Returns:

anychart.graphics.vector.Stroke - Returns stroke.
Set stroke using one parameter.
Available options: Note: String parts order is significant and '3px red' is not the same as 'red 3px'.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null Stroke as '[thickness ]color[ opacity]'.

Returns:

anychart.graphics.vector.Shape - Self instance for method chaining.
Sets stroke settings.
Note: When stroke properties are set both by complex stroke object properties and by stroke() method params, object properties have more priority. E.g. setting shape.stroke('10 red', 5); (or shape.stroke({color: 'red', thickness: 10}, 5); will result a red stroke with thickness 10px.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string Stroke style, as described above.
thickness number Line thickness. Defaults to 1.
dashpattern string Controls the pattern of dashes and gaps used to stroke paths. Dash array contains a list of white space separated lengths and percentages that specify the lengths of alternating dashes and gaps. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. Thus, stroke dashpattern: '5 3 2' is equivalent to dashpattern: '5 3 2 5 3 2'.
lineJoin anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

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

Try it:

strokeThickness

Gets stroke thickness.

Returns:

number - Thickness value.
Sets stroke thickness.

Params:

Name Type Description
value number Thickness value.

Returns:

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

Try it:

translate

Moves a shape taking an account the current transformation. Movement happens in a shape coordinate system (not the coordinate system of the parent).

Params:

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

Returns:

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

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope SCOPE Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

visible

Gets/sets the current visibility flag.

Returns:

boolean - Returns the current visibility flag.
Hides or shows an element.

Params:

Name Type Description
isVisible boolean Visibility flag.

Returns:

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

Try it:

zIndex

Gets and sets element's zIndex.

Params:

Name Type Description
value number Z index to set.

Returns:

number anychart.graphics.vector.Element - Z index or itself for chaining.