class anychart.core.ui.CrosshairLabel Improve this Doc

Extends: anychart.core.Text

The CrosshairLabel class contains methods for configuring the label of the crosshair.
Crosshair label is used in text and position settings, the coloring, interactivity states and other settings.

Try it:

Methods Overview

Specific settings
axisIndex()	Axis index.
format()	Text formatter function.
Advanced Text Settings
adjustFontSize()	Adjust font settings.
fontVariant()	Font variant settings.
letterSpacing()	Text letter spacing settings.
maxFontSize()	Maximum font size setting.
minFontSize()	Minimum font size setting.
textDirection()	Text direction settings.
textIndent()	Text indent settings.
textOverflow()	Text overflow settings.
useHtml()	Text useHtml settings.
wordBreak()	Word break mode.
wordWrap()	Word-wrap mode.
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.
Coloring
background()	Background settings.
Events
disablePointerEvents()	Pointer events settings.
Interactivity
enabled()	Element state (enabled or disabled).
selectable()	Text selectable option.
Size and Position
anchor()	Anchor settings.
height()	Height settings.
offsetX()	Offset by X.
offsetY()	Offset by Y.
padding()	Padding settings.
position()	Label position.
rotation()	Rotation settings.
width()	Width settings.
zIndex()	Z-index of the element.
Text Settings
textSettings()	Text settings.

Methods Description

adjustFontSize

adjustFontSize()

Getter for adjust font settings.

Detailed description

Returns an array of two elements [isAdjustByWidth, isAdjustByHeight].

[false, false] - do not adjust (adjust is off )
[true, false] - adjust width
[false, true] - adjust height
[true, true] - adjust the first suitable value.

Returns:

Object - Adjust font size.

Try it:

Usage sample

adjustFontSize(bothOrByWidth, byHeight)

Setter for adjust font settings.

Detailed description

Minimal and maximal font sizes can be configured using: anychart.core.ui.CrosshairLabel#minFontSize and anychart.core.ui.CrosshairLabel#maxFontSize.
Note: Works only when anychart.core.ui.CrosshairLabel#width and anychart.core.ui.CrosshairLabel#height are set.
Note: anychart.core.ui.CrosshairLabel#fontSize does not work when adjusting is enabled.

Params:

Name	Type	Default	Description
bothOrByWidth	Object \| Array.<boolean> \| boolean	{width: false, height: false}	If only one param is set, its value goes for another too.
byHeight	boolean		Is font needs to be adjusted by height.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Example.

label.adjustFontSize(false);
// the same
label.adjustFontSize(false, false);
// the same
label.adjustFontSize([false, false]);

Try it:

Usage sample

anchor

anchor()

Getter for crosshair label anchor settings.

Returns:

anychart.enums.Anchor | string - Label anchor settings.

Try it:

Usage sample

anchor(anchor)

Setter for the crosshair label anchor settings.

Params:

Name	Type	Default	Description
anchor	anychart.enums.Anchor \| string	null	Value to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

axisIndex

axisIndex()Since version 7.6.0

Getter for the axis index.

Returns:

number - Axis index

Try it:

Usage sample

axisIndex(value)Since version 7.6.0

Setter for the axis index.

Params:

Name	Type	Default	Description
value	number	0	Axis index

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

background

background()

Getter for crosshair label background settings.

Returns:

anychart.core.ui.Background - Returns background settings.

Try it:

Usage sample

background(settings)

Setter for crosshair label background settings.

Detailed description

Sets label background settings depending on parameter type:

null/boolean - disable or enable label background.
object - sets label background settings.
string - sets label background color.

Params:

Name	Type	Default	Description
settings	string \| Object \| null \| boolean	true	Value to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

disablePointerEvents

disablePointerEvents()

Getter for the pointer events.

Returns:

boolean - Flag of the state.

Try it:

Usage sample

disablePointerEvents(enabled)

Setter for the pointer events.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the label state (enabled or disabled).

Returns:

boolean - Element state.

See listing

var enabled = label.enabled();

enabled(enabled)

Setter for the label enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

Try it:

Usage sample

fontColor(color)

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

Params:

Name	Type	Default	Description
color	string	'#7c868e'	Value to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

fontDecoration

fontDecoration()

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - Font decoration.

Try it:

Usage sample

fontDecoration(value)

Setter for the text font decoration.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.Decoration \| string	'none'	Font decoration to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the font family.

Returns:

string - Font family.

Try it:

Usage sample

fontFamily(family)

Setter for the font family.

Params:

Name	Type	Default	Description
family	string	'Verdana', Helvetica, Arial, sans-serif	Font family to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

fontOpacity

fontOpacity()

Getter for the text font opacity.

Returns:

number - Font opacity.

Try it:

Usage sample

fontOpacity(opacity)

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

Params:

Name	Type	Default	Description
opacity	number	1	Value to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

Name	Type	Default	Description
size	string \| number	16	Font size to set.

fontStyle

fontStyle()

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.

Try it:

Usage sample

fontStyle(style)

Setter for the text font style.

Params:

Name	Type	Default	Description
style	anychart.graphics.vector.Text.FontStyle \| string	'normal'	Font style to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

fontVariant

fontVariant()

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - Font variant.

Try it:

Usage sample

fontVariant(value)

Setter for the text font variant.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.FontVariant \| string	'normal'	Font variant to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - Font weight.

Try it:

Usage sample

fontWeight(weight)

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

Params:

Name	Type	Default	Description
weight	string \| number	'normal'	Font weight to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

format

format()Since version 7.6.0

Getter for labels format function.

Returns:

function - Labels format function.

Try it:

Usage sample

format(token)

Setter for the labels format.
Learn more about using the format() method.

Params:

Name	Type	Description
token	string	String token to format content label text.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

format(function)Since version 7.6.0

Setter for labels format using function.
Learn more about using format() method.

Params:

Name	Type	Description
function	function	Function to format label text.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.

Try it:

Usage sample

hAlign(align)

Setter for the text horizontal align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.HAlign \| string	'start'	Value to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

height

height()

Getter for the crosshair label height.

Returns:

number | string | null - Label height.

Try it:

Usage sample

height(height)

Setter for the crosshair label height.

Detailed description

Note: if null is passed, height is calculated automatically.

Params:

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

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

letterSpacing

letterSpacing()

Getter for the text letter spacing.

Returns:

string | number - Letter spacing.

Try it:

Usage sample

letterSpacing(spacing)

Setter for the text letter spacing.
https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

Name	Type	Default	Description
spacing	string \| number	'normal'	Value to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - Text line height.

Try it:

Usage sample

lineHeight(height)

Setter for the text line height.
https://www.w3schools.com/cssref/pr_dim_line-height.asp

Params:

Name	Type	Default	Description
height	string \| number	'normal'	Value to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

maxFontSize

maxFontSize()

Getter for the maximum font size for adjust text to.

Returns:

number - Maximum font size.

Try it:

Usage sample

maxFontSize(size)

Setter for the maximum font size for adjust text to.

Detailed description

Note: works only when adjusting is enabled. Look anychart.core.ui.CrosshairLabel#adjustFontSize.

Params:

Name	Type	Default	Description
size	number \| string	72	Maximum font size to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

minFontSize

minFontSize()

Getter for the minimum font size for adjust text from.

Returns:

number - Minimum font size.

Try it:

Usage sample

minFontSize(size)

Setter for the minimum font size for adjust text from.

Detailed description

Note: works only when adjusting is enabled. Look anychart.core.ui.CrosshairLabel#adjustFontSize.

Params:

Name	Type	Default	Description
size	number \| string	8	Minimum font size to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

offsetX

offsetX()

Getter for crosshair label offsetX settings.

Returns:

number | string - Label offsetX value.

Try it:

Usage sample

offsetX(offset)

Setter for crosshair label offsetX settings.

Arrows show offsets layout.

Params:

Name	Type	Default	Description
offset	number \| string	0	Offset by X to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

offsetY

offsetY()

Getter for crosshair label offsetY settings.

Returns:

number | string - Label offsetY value.

Try it:

Usage sample

offsetY(offset)

Setter for crosshair label offsetY settings. See illustration in anychart.core.ui.CrosshairLabel#offsetX.

Params:

Name	Type	Default	Description
offset	number \| string	0	Offset by Y to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

padding

padding()

Getter for the crosshair label padding.

Detailed description

Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.

Returns:

anychart.core.utils.Padding - Label padding.

Try it:

Usage sample

padding(padding)

Setter for crosshair label padding in pixels by one value.

Params:

Name	Type	Default	Description
padding	Array.<(number\|string)> \| Object	{top: 5, right: 10, bottom: 5, left: 10}	Padding to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for crosshair label padding in pixels.

Params:

Name	Type	Default	Description
value1	string \| number	5	Top or top-bottom space.
value2	string \| number	10	Right or right-left space.
value3	string \| number	5	Bottom space.
value4	string \| number	10	Left space.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Example

// 1) top and bottom 10px, left and right 15px
label.padding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
label.padding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
label.padding(10, '15px', '5px', 12);

Try it:

Usage sample

position

position()

Getter for label position.

Returns:

anychart.enums.SidePosition | string - Label position.

position(value)

Setter for label position.

Params:

Name	Type	Default	Description
value	anychart.enums.Position \| string	'center'	Position to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

rotation

rotation()

Getter for the rotation angle around an anchor.

Returns:

number - Rotation angle in degrees.

rotation(angle)

Setter for the rotation angle around an anchor.

Params:

Name	Type	Default	Description
angle	number	0	Rotation angle in degrees.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

selectable

selectable()

Getter for the text selectable option.

Returns:

boolean - The text selectable option.

Try it:

Usage sample

selectable(enabled)

Setter for the text selectable.

Detailed description

This options defines whether the text can be selected. If set to false one can't select the text.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

textDirection

textDirection()

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Text direction.

Try it:

Usage sample

textDirection(direction)

Setter for the text direction.

Params:

Name	Type	Default	Description
direction	anychart.graphics.vector.Text.Direction \| string	'ltr'	Text direction to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

textIndent

textIndent()

Getter for the text indent.

Returns:

number - Text indent.

Try it:

Usage sample

textIndent(indent)

Setter for the text indent.

Params:

Name	Type	Default	Description
indent	number	0	Text indent to set.

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

textOverflow

textOverflow()

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.

See listing

var title = chart.title();
var textOverflow = title.textOverflow();

textOverflow(value)

Setter for the text overflow settings.

Params:

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

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it:

Usage sample

textSettings

textSettings()

Getter for the full text appearance settings.

Returns:

Object - A copy of settings object.

Try it:

Usage sample

textSettings(name)

Getter for all text appearance settings.

Detailed description

Note: Returns undefined if the name of the setting is wrong.

Params:

Name	Type	Description
name	string	Setting name.

Returns:

string | number | boolean | undefined - Value of settings.

Try it:

Usage sample

textSettings(objectWithSettings)

Setter for text appearance settings.

Detailed description

Overrides current text settings by passed settings object.

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, 'wordWrap': smth, 'wordBreak': smth, 'textOverflow': smth, 'selectable': smth, 'useHtml': smth 'textShadow':smth }

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,
     'wordWrap': smth,
     'wordBreak': smth,
     'textOverflow': smth,
     'selectable': smth,
     'useHtml': smth
     'textShadow':smth
   }

Returns:

anychart.core.ui.CrosshairLabel - Self instance for method chaining.

Try it: