Top

class anychart.graphics.vector.vml.Text Improve this Doc

Extends: anychart.graphics.vector.Text

A class for text formatting.
Processes plain text and HTML text.
Plain text is set using the setText method anychart.graphics.vector.Text#text. HTML text is set using the setHtml method anychart.graphics.vector.Text#htmlText. A text style is set using the setStyle method anychart.graphics.vector.Text#style.

Try it:

Methods Overview

Coloring
color()Color setting.
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().
Interactive
drag()Dragging setting.
Interactivity
visible()Visibility flag
Size and Position
appendTransformationMatrix()Combines the current 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 current rotation angle in degrees.
getTransformationMatrix()Returns the current 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.
height()Height setting.
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 current transformation.
width()Width setting.
x()X coordinate setting.
y()Y coordinate setting.
zIndex()Z-index setting.
Miscellaneous
attr()Attribute setting
clip()Clipping setting.
cursor()Cursor type.
decoration()Text decoration setting.
desc()Description setting
direction()Text direction setting.
disablePointerEvents()Pointer events setting.
disableStrokeScaling()Vector effect property
dispose()Disposes element completely.
domElement()Returns DOM element if element is rendered.
fontFamily()Font family setting.
fontSize()Font size setting.
fontStyle()Font style setting.
fontVariant()Font variant setting.
fontWeight()Font weight setting.
getStage()Stage object (to which the given element is bound).
hAlign()Horizontal align setting.
hasParent()Whether parent element is set.
htmlText()HTML format.
id()Element identifier
letterSpacing()Letter spacing setting.
lineHeight()Line height setting.
opacity()Opacity setting.
parent()Parent layer.
remove()Current element removes itself from the parent layer.
selectable()Text selection setting.
style()Text style settings.
text()Text setting.
textIndent()Text indent setting.
textOverflow()Text overflow setting.
textWrap()Text wrap setting.
title()Title setting
vAlign()Vertical align setting.

Methods Description

appendTransformationMatrix

Combines the current transformation with the given transformation matrix.

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:

attr

Getter for the attribute.

Params:

Name Type Description
key string Name of attribute.

Returns:

* - Attribute value.

Try it:

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:

clip

Gets the current clipping rectangle.

Returns:

anychart.graphics.math.Rect - An instance of the class for method chaining.
Sets the clipping rectangle.

Params:

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

Returns:

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

Try it:

color

Getter for the current text color.

Returns:

string - The current text color.

Try it:

Setter for text color.

Params:

Name Type Default Description
value string
"#000"
Text color.

Returns:

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

Try it:

cursor

Getter for the current cursor type.

Returns:

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

Try it:

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:

decoration

Getter for the current text decoration.

Returns:

string - The current text decoration.

Try it:

Setter for text decoration.

Params:

Name Type Description
value anychart.graphics.vector.Text.Decoration | string Text decoration.

Returns:

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

Try it:

desc

Getter for the element description value.

Returns:

string null undefined - The element description value.

Try it:

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:

direction

Getter for the current text direction.

Returns:

string - The current text direction

Try it:

Setter for text direction.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.Direction | string
"ltr"
Text direction.

Returns:

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

Try it:

disablePointerEvents

Gets the current value of the pointer events.

Returns:

boolean - Returns property value.

Try it:

Disables the pointer events.

Params:

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

Returns:

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

Try it:

disableStrokeScaling

Getter for the current element's vector effect property.

Returns:

boolean - The current vector effect property.
See listing
var element = stage.rect(10, 10, 100, 40);
element.disableStrokeScaling();
Setter for the element's vector effect property.
Learn more by link.

Params:

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

Returns:

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

Try it:

dispose

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

Try it:

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 the current state flag.

Returns:

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

Try it:

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

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:

fontFamily

Getter for the current font family of text.

Returns:

string - The current font family.

Try it:

Setter for font family of text.

Params:

Name Type Default Description
value string
"Verdana"
Font family.

Returns:

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

Try it:

fontSize

Getter for the current font size of text.

Returns:

string number - The current font size.

Try it:

Setter for font size of text.

Params:

Name Type Default Description
value string | number
"10px"
Font size.

Returns:

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

Try it:

fontStyle

Getter for the current font style of text.

Returns:

string - The current font style.

Try it:

Setter for font style of text.

Params:

Name Type Description
value anychart.graphics.vector.Text.FontStyle | string Font style.

Returns:

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

Try it:

fontVariant

Getter for the current font variant of text.

Returns:

string - The current font variant

Try it:

Setter for font variant of text.

Params:

Name Type Description
value anychart.graphics.vector.Text.FontVariant | string Font variant.

Returns:

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

Try it:

fontWeight

Getter for the current font weight of text.

Returns:

string - The current font weight.

Try it:

Setter for font weight of text.

Params:

Name Type Description
value string | number Font weight.

Returns:

anychart.graphics.vector.Text - 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.

Try it:

getAbsoluteHeight

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

Returns:

number - Height.

Try it:

getAbsoluteWidth

Returns width within root bounds.

Returns:

number - Width.

Try it:

getAbsoluteX

Returns an absolute X (root element coordinate system).

Returns:

number - Absolute X.

Try it:

getAbsoluteY

Returns an absolute Y (root element coordinate system).

Returns:

number - Absolute Y.

Try it:

getBounds

Returns the bounds.

Returns:

anychart.graphics.math.Rect - Bounds.

Try it:

getHeight

Returns the height.

Returns:

number - Height.

Try it:

getRotationAngle

Returns the current rotation angle in degrees.

Returns:

number - Rotation angle.

Try it:

getStage

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

Returns:

anychart.graphics.vector.Stage - Stage object.

Try it:

getTransformationMatrix

Returns the current transformation matrix.

Returns:

Array.<number> - Transformation matrix array.

Try it:

getWidth

Returns the width.

Returns:

number - Width.

Try it:

getX

Returns X in the coordinate system of the parent.

Returns:

number - X in the coordinate system of the parent.

Try it:

getY

Returns Y in the coordinate system of the parent.

Returns:

number - Y in the coordinate system of the parent.

Try it:

hAlign

Getter for the current horizontal align of text.

Returns:

string - The current horizontal align.

Try it:

Setter for horizontal align of text.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.HAlign | string
"start"
Horizontal align.

Returns:

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

Try it:

hasParent

Whether parent element is set.

Returns:

boolean - Whether parent element is set.

Try it:

height

Gets the current height.
Note: it is not calculated automatically and has no default, and if it was not set using setter - NaN is returned.

Returns:

number string - The current height.

Try it:

Sets a height.

Params:

Name Type Description
value number | string Height.

Returns:

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

Try it:

htmlText

Getter for the current HTML format.

Returns:

string - Current plain text.

Try it:

Setter for the HTML format.

Params:

Name Type Description
value string Text with HTML tags.

Returns:

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

Try it:

id

Gets the current element identifier.

Returns:

string - Returns element identifier.

Try it:

Sets the element identifier.

Params:

Name Type Description
value string Custom identifier.

Returns:

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

Try it:

letterSpacing

Getter for the current letter spacing of text.

Returns:

string - The current letter spacing.

Try it:

Setter for letter spacing of text.

Params:

Name Type Description
value string | number Letter spacing.

Returns:

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

Try it:

lineHeight

Getter for the current line height of text.

Returns:

string - The current line height.

Try it:

Sets line height, either as ratio or in pixels.

Params:

Name Type Description
value string | number Letter height.

Returns:

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

Try it:

listen

Adds an event listener.

Params:

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

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

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

Params:

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

Returns:

Object - Unique key for the listener.

Try it:

opacity

Getter for the current text opacity.

Returns:

number - The current text opacity.

Try it:

Setter for text opacity.

Params:

Name Type Description
value number Text opacity.

Returns:

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

Try it:

parent

Returns the parent layer.

Returns:

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

Try it:

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.

Try it:

remove

Current element removes itself from the parent layer.

Returns:

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

Try it:

removeAllListeners

Removes all listeners from this listenable.

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:

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.

Try it:

rotateByAnchor

Rotates a shape around the given anchor.

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:

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.

Try it:

scaleByAnchor

Scales a shape by anchor. 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.

Try it:

selectable

Getter for the current text selectable property.

Returns:

boolean - The current text selectable setting.

Try it:

Setter for the text selectable property.
Defines whether text can be selected. If false - no selection.

Params:

Name Type Default Description
value boolean
true
Text selectable property.

Returns:

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

Try it:

setPosition

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

Params:

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

Returns:

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

Try it:

setRotation

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

Try it:

setRotationByAnchor

Rotates a shape around the given anchor.

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:

setTransformationMatrix

Sets the transformation matrix.

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:

style

Getter for the current text style.

Returns:

anychart.graphics.vector.TextStyle - The current text style.

Try it:

Setter for the text style.

Params:

Name Type Description
value anychart.graphics.vector.TextStyle Style.

Returns:

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

Try it:

text

Getter for the current text.

Returns:

string - Current text.

Try it:

Setter for the text.

Params:

Name Type Description
value string Plaint text.

Returns:

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

Try it:

textIndent

Getter for the current text indent.

Returns:

number - The current text indent.

Try it:

Setter for text indent.
The text-indent property specifies the indentation of the first line in a text-block.

Params:

Name Type Description
value number Text indent of text.

Returns:

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

Try it:

textOverflow

Getter for the current font text overflow of text.

Returns:

string - The current text overflow.

Try it:

Setter for the font text overflow of text.

Params:

Name Type Description
value anychart.graphics.vector.Text.TextOverflow | string Text overflow.

Returns:

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

Try it:

textWrap

Getter for the current text wrap of text.

Returns:

string - The current text wrap.

Try it:

Setter for text wrap of text.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.TextWrap | string
"noWrap"
Text wrap.

Returns:

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

Try it:

title

Getter for the element title value.

Returns:

string null undefined - The element title value.

Try it:

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:

translate

Moves a shape taking an account the current transformation.

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:

unlisten

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

Params:

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

Returns:

boolean - Whether any listener was removed.

Try it:

vAlign

Getter for the current vertical align of text.

Returns:

string - The current vertical align.

Try it:

Setter for vertical align of text.

Params:

Name Type Description
value anychart.graphics.vector.Text.VAlign | string Vertical align.

Returns:

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

Try it:

visible

Gets the current visibility flag.

Returns:

boolean - Returns the current visibility flag.

Try it:

Hides or shows an element.

Params:

Name Type Default Description
isVisible boolean
true
Visibility flag.

Returns:

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

Try it:

width

Gets the current width.
Note: it is not calculated automatically and has no default, and if it was not set using setter - NaN is returned.

Returns:

number string - The current width.

Try it:

Sets a width.

Params:

Name Type Description
value number | string Width.

Returns:

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

Try it:

x

Getter for the current X coordinate of text.

Returns:

number - The current X coordinate.

Try it:

Setter for X coordinate of text.

Params:

Name Type Description
value number X coordinate.

Returns:

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

Try it:

y

Getter for the current Y coordinate of text.

Returns:

number - The current Y coordinate.

Try it:

Setter for Y coordinate of text.

Params:

Name Type Description
value number Y coordinate.

Returns:

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

Try it:

zIndex

Gets the current element's zIndex.

Returns:

number - Z-index.

Try it:

Sets the element's zIndex.

Params:

Name Type Description
value number Z-index to set.

Returns:

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

Try it: