class anychart.core.axisMarkers.Text Improve this Doc
Extends: anychart.core.Text
Text marker.
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. |
rotation() | Rotation settings. |
width() | Text marker width. |
zIndex() | Z-index of the element. |
Text Settings | |
textSettings() | Text settings. |
Methods Description
align
Returns:
anychart.enums.Align | string - The text marker align.Try it:
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
Returns:
anychart.enums.Anchor | string - Text marker anchor settings.Try it:
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
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:
disablePointerEvents
Returns:
boolean - Flag of the current state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
enabled
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
fontColor
https://www.w3schools.com/html/html_colors.asp
Params:
Name | Type | Default | Description |
---|---|---|---|
value | string | "#7c868e" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
fontDecoration
Returns:
anychart.graphics.vector.Text.Decoration | string - The current font decoration.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.Decoration | string | "none" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
fontFamily
Params:
Name | Type | Default | Description |
---|---|---|---|
value | string | "Verdana", Helvetica, Arial, sans-serif | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
fontOpacity
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 1 | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
fontSize
Returns:
string | number - Current font size.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | string | number | 16 | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
fontStyle
Returns:
anychart.graphics.vector.Text.FontStyle | string - The current font style.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.FontStyle | string | "normal" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
fontVariant
Returns:
anychart.graphics.vector.Text.FontVariant | string - The current font variant.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.FontVariant | string | "normal" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
fontWeight
Returns:
string | number - The current font weight.Try it:
https://www.w3schools.com/cssref/pr_font_weight.asp
Params:
Name | Type | Default | Description |
---|---|---|---|
value | string | number | "normal" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
hAlign
Returns:
anychart.graphics.vector.Text.HAlign | string - The current text horizontal align.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.HAlign | string | "start" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
height
Returns:
number | string | null - The text marker height.var textMarkerSettings = chart.textMarker(); var currentHeight = textMarkerSettings.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
Returns:
boolean - Returns true if the text marker's layout is horizontal.Try it:
layout
Returns:
anychart.enums.Layout | string - The text marker layout.Try it:
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
Returns:
string | number - The current letter spacing.Try it:
https://www.w3schools.com/cssref/pr_text_letter-spacing.asp
Params:
Name | Type | Default | Description |
---|---|---|---|
value | string | number | "normal" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
lineHeight
Returns:
string | number - The current text line height.Try it:
https://www.w3schools.com/cssref/pr_dim_line-height.asp
Params:
Name | Type | Default | Description |
---|---|---|---|
value | string | number | "normal" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
listen
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
Name | Type | Default | 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 | 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:
listenOnce
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | 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:
offsetX
Returns:
number | string - The offset by x.var textMarkerSettings = chart.textMarker(); var currentOffsetX = textMarkerSettings.offsetX();
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
Returns:
number | string - The text marker offset by y.var textMarkerSettings = chart.textMarker(); var currentOffsetY = textMarkerSettings.offsetY();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | 0 | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
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
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
Returns:
null | number - The text marker rotation.var textMarkerSettings = chart.textMarker(); var currentRotation = textMarkerSettings.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
Returns:
anychart.scales.Base - 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
Returns:
boolean - The current text selectable option.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
text
Returns:
string - The text marker settings.var textMarkerSettings = chart.textMarker(); var currentText = textMarkerSettings.text();
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
Returns:
anychart.graphics.vector.Text.Direction | string - Current text direction.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.Direction | string | "ltr" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
textIndent
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
textOverflow
Returns:
anychart.graphics.vector.Text.TextOverflow | string - The current text overflow settings.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.TextOverflow | string | "" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
textSettings
Returns:
Object - A copy of settings object.Try it:
Params:
Name | Type | Description |
---|---|---|
name | string | Setting name. |
Returns:
string | number | boolean | undefined - Value of the setting.Try it:
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.axisMarkers.Text - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
name | string | Setting name. |
value | string | number | boolean | function | Settings value. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
textWrap
Returns:
anychart.graphics.vector.Text.TextWrap | string - The current text wrap settings.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.TextWrap | string | "byLetter" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
unlisten
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | 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:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
useHtml
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
vAlign
Returns:
anychart.graphics.vector.Text.VAlign | string - The current text vertical align.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.VAlign | string | "top" | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it:
value
Returns:
number - The text marker value.var textMarkerSettings = chart.textMarker(); var currentValue = textMarkerSettings.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
Returns:
number | string | null - The text marker width.var textMarkerSettings = chart.textMarker(); var currentWidth = textMarkerSettings.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
Returns:
number - The current zIndex.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.axisMarkers.Text - Self instance for method chaining.Try it: