Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.standalones.axisMarkers.Text Improve this Doc

Methods Overview

Specific settings
text()Text settings.
value()Text marker value.
Advanced Text Settings
fontVariant()Font variant settings.
letterSpacing()Text letter spacing settings.
textDirection()Text direction settings.
textIndent()Text indent settings.
textOverflow()Text overflow settings.
textWrap()Text wrap settings.
useHtml()Text useHtml settings.
Axes and Scales
axis()Axis settings.
scale()Scale settings.
Base Text Settings
fontColor()Font color settings.
fontDecoration()Font decoration settings.
fontFamily()Font family settings.
fontOpacity()Font opacity settings.
fontSize()Font size settings.
fontStyle()Font style settings.
fontWeight()Font weight settings.
hAlign()Text horizontal align settings.
lineHeight()Text line height settings.
vAlign()Text vertical align settings.
Events
disablePointerEvents()Pointer events settings.
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Removes all listeners.
unlisten()Removes the listener.
unlistenByKey()Removes the listener by the key.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
selectable()Text selectable option.
Size and Position
align()Align settings.
anchor()Anchor settings.
height()Text marker height.
isHorizontal()Whether a text marker has horizontal layout.
layout()Layout settings.
offsetX()Text marker offset by x.
offsetY()Text marker offset by y.
parentBounds()Parent bounds for text marker.
rotation()Rotation settings.
width()Text marker width.
zIndex()Z-index of the element.
Text Settings
textSettings()Text settings.
Miscellaneous
container()Container for text marker.
draw()Drawing of the text marker.

Methods Description

align

Getter for the text marker align.

Returns:

anychart.enums.Align string - The text marker align.

Try it:

Setter for the text marker align.

Params:

Name Type Default Description
value anychart.enums.Align | string
"center"
Text marker align.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

anchor

Getter for the text marker anchor settings.

Returns:

anychart.enums.Anchor string - Text marker anchor settings.

Try it:

Setter for the text marker anchor settings.

Params:

Name Type Default Description
value anychart.enums.Anchor | string
"center"
Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

axis

Getter for the text marker axis.

Returns:

anychart.core.axes.Linear - The text marker axis.

Try it:

Setter for the text marker axis.

Params:

Name Type Default Description
value anychart.core.axes.Linear
null
Value to set.

Returns:

anychart.core.axisMarkers.Line - Self instance for method chaining.

Try it:

container

Getter for the text marker current container.
Setter for the text marker current container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.standalones.axisMarkers.Text - Self instance for method chaining.

Try it:

disablePointerEvents

Getter for the current pointer events.

Returns:

boolean - Flag of the current state.

Try it:

Setter for the pointer events.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

draw

Drawing of the text marker.

Returns:

anychart.standalones.axisMarkers.Text - Self instance for method chaining.

Try it:

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

fontColor

Getter for the text font color.

Returns:

string - The current font color.

Try it:

Setter for the text font color.
https://www.w3schools.com/html/html_colors.asp

Params:

Name Type Default Description
value string
"#7c868e"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontDecoration

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration string - The current font decoration.

Try it:

Setter for the text font decoration.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.Decoration | string
"none"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontFamily

Getter for the current font family.

Returns:

string - The current font family.

Try it:

Setter for font family.

Params:

Name Type Default Description
value string
"Verdana", Helvetica, Arial, sans-serif
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontOpacity

Getter for the text font opacity.

Returns:

number - The current font opacity.

Try it:

Setter for the text font opacity. Double value from 0 to 1.

Params:

Name Type Default Description
value number
1
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontSize

Getter for the current text font size.

Returns:

string number - Current font size.

Try it:

Setter for text font size.

Params:

Name Type Default Description
value string | number
16
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontStyle

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle string - The current font style.

Try it:

Setter for the text font style.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.FontStyle | string
"normal"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontVariant

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant string - The current font variant.

Try it:

Setter for the text font variant.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.FontVariant | string
"normal"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontWeight

Getter for the text font weight.

Returns:

string number - The current font weight.

Try it:

Setter for the text font weight.
https://www.w3schools.com/cssref/pr_font_weight.asp

Params:

Name Type Default Description
value string | number
"normal"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

hAlign

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign string - The current text horizontal align.

Try it:

Setter for the text horizontal align.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.HAlign | string
"start"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

height

Getter for the text marker height.

Returns:

number string null - The text marker height.
See listing
var textMarkerSettings = chart.textMarker();
var currentHeight = textMarkerSettings.height();
Setter for the text marker height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

isHorizontal

Whether a text marker has horizontal layout. Layout is define by anychart.core.axisMarkers.Text#layout method.

Returns:

boolean - Returns true if the text marker's layout is horizontal.

Try it:

layout

Getter for text marker layout.

Returns:

anychart.enums.Layout string - The text marker layout.

Try it:

Setter for text marker layout.

Params:

Name Type Default Description
value anychart.enums.Layout | string
"horizontal"
Text marker layout.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

letterSpacing

Getter for the text letter spacing.

Returns:

string number - The current letter spacing.

Try it:

Params:

Name Type Default Description
value string | number
"normal"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

lineHeight

Getter for the text line height.

Returns:

string number - The current text line height.

Try it:

Params:

Name Type Default Description
value string | number
"normal"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method. Function that looks like function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

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 Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

offsetX

Getter for the text marker offset by x.

Returns:

number string - The offset by x.
See listing
var textMarkerSettings = chart.textMarker();
var currentOffsetX = textMarkerSettings.offsetX();
Setter for the text marker offset by x.

Params:

Name Type Default Description
value number | string
0
Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

offsetY

Getter for the text marker offset by y.

Returns:

number string - The text marker offset by y.
See listing
var textMarkerSettings = chart.textMarker();
var currentOffsetY = textMarkerSettings.offsetY();
Setter for the text marker offset by y.

Params:

Name Type Default Description
value number | string
0
Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

parentBounds

Getter for bounds.

Returns:

anychart.math.Rect - Current stage bounds.
Setter for bounds using single value.

Params:

Name Type Description
value anychart.math.Rect | Object | null Value to set

Returns:

anychart.standalones.axisMarkers.Text - Self instance for method chaining.

Try it:

Setter for bounds using several values.

Params:

Name Type Description
left number Left space
top number Top space
width number Width line marker
height number Height line marker

Returns:

anychart.standalones.axisMarkers.Text - Self instance for method chaining.

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscape boolean
false
Flag of landscape.

Try it:

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

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:

rotation

Getter for the text marker rotation in degrees.

Returns:

null number - The text marker rotation.
See listing
var textMarkerSettings = chart.textMarker();
var currentRotation = textMarkerSettings.rotation();
Setter for the text marker rotation.

Params:

Name Type Default Description
value number
null
Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

scale

Getter for the text marker scale.

Returns:

anychart.scales.Base - The text marker scale.
Setter for the text marker scale.

Params:

Name Type Description
value anychart.scales.Base Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

selectable

Getter for the text selectable option.

Returns:

boolean - The current text selectable option.

Try it:

Setter for the text selectable.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

text

Getter for the text marker text settings.

Returns:

string - The text marker settings.
See listing
var textMarkerSettings = chart.textMarker();
var currentText = textMarkerSettings.text();
Setter for the text marker text settings.

Params:

Name Type Default Description
value string
"Text marker"
Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

textDirection

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction string - Current text direction.

Try it:

Setter for the text direction.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.Direction | string
"ltr"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textIndent

Getter for the text indent.

Returns:

number - The current text indent.

Try it:

Setter for the text indent.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow string - The current text overflow settings.

Try it:

Setter for the text overflow settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.TextOverflow | string
""
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textSettings

Getter for the full text appearance settings.

Returns:

Object - A copy of settings object.

Try it:

Getter for all text appearance settings.

Params:

Name Type Description
name string Setting name.

Returns:

string number boolean undefined - Value of the setting.

Try it:

Setter for text appearance settings.

Params:

Name Type Description
objectWithSettings Object Settings object. Complete object looks like this: { "fontSize": smth, "fontFamily": smth, "fontColor": smth, "fontOpacity": smth, "fontDecoration": smth, "fontStyle": smth, "fontVariant": smth, "fontWeight": smth, "letterSpacing": smth, "textDirection": smth, "lineHeight": smth, "textIndent": smth, "vAlign": smth, "hAlign": smth, "textWrap": smth, "textOverflow": smth, "selectable": smth, "useHtml": smth }.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

Setter for the text appearance settings.

Params:

Name Type Description
name string Setting name.
value string | number | boolean | function Settings value.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textWrap

Getter for the text wrap settings.

Returns:

anychart.graphics.vector.Text.TextWrap string - The current text wrap settings.

Try it:

Setter for the text wrap settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.TextWrap | string
"byLetter"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

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 Object Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

useHtml

Getter for the useHTML flag.

Returns:

boolean - The current value of useHTML flag.

Try it:

Setter for flag useHTML.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

vAlign

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign string - The current text vertical align.

Try it:

Setter for the text vertical align.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.VAlign | string
"top"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

value

Getter for the text marker value.

Returns:

number - The text marker value.
See listing
var textMarkerSettings = chart.textMarker();
var currentValue = textMarkerSettings.value();
Setter for the text marker value.

Params:

Name Type Default Description
value number
0
Value to set

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

width

Getter for the text marker width.

Returns:

number string null - The text marker width.
See listing
var textMarkerSettings = chart.textMarker();
var currentWidth = textMarkerSettings.width();
Setter for the text marker width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.axisMarkers.Text - Self instance for method chaining.

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: