class anychart.core.resource.resourceList.TagsSettings Improve this Doc

Extends: anychart.core.resource.resourceList.TextSettings

Tags settings class.

Methods Overview

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.
fontVariant()	Font variant settings.
fontWeight()	Font weight settings.
hAlign()	Font horizontal align settings.
letterSpacing()	Letter spacing settings.
lineHeight()	Line height settings.
selectable()	Text selectable settings.
textDirection()	Text direction settings.
textIndent()	Text indent settings.
textOverflow()	Text overflow settings.
useHtml()	Text useHtml settings.
vAlign()	Font vertical align settings.
wordBreak()	Word break mode.
wordWrap()	Word-wrap mode.
Coloring
background()	Background settings.
Content Text Settings
disablePointerEvents()	Pointer events settings.
Size and Position
margin()	Margin settings.
padding()	Padding settings.

Methods Description

background

background()Since version 7.12.0

Getter for tags background.

Returns:

anychart.core.ui.Background - Background instance.

background(settings)Since version 7.12.0

Setter for tags background.

Detailed description

Sets background settings depending on parameter type:

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

Params:

Name	Type	Description
settings	string \| Object \| null \| boolean	Background settings.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

disablePointerEvents

disablePointerEvents()

Getter for the pointer events settings.

Returns:

boolean - The pointer events settings.

See listing

var tags = resourceList.tags();
var disablePointerEvents = tags.disablePointerEvents();

disablePointerEvents(enabled)

Setter for the pointer events setting.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

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

fontColor

fontColor()Since version 7.12.0

Getter for the font color.

Returns:

string - Text font color.

See listing

var names = resourceList.names();
var color = names.fontColor();

fontColor(color)Since version 7.12.0

Setter for the font color.

Params:

Name	Type	Default	Description
color	string	'#000'	Font color.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

fontDecoration

fontDecoration()Since version 7.12.0

Getter for the text font decoration.

Returns:

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

See listing

var names = resourceList.names();
var fontDecoration = names.fontDecoration();

fontDecoration(type)Since version 7.12.0

Setter for the text font decoration.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

fontFamily

fontFamily()Since version 7.12.0

Getter for the font family.

Returns:

string - Text font family.

See listing

var names = resourceList.names();
var font = names.fontFamily();

fontFamily(fontFamily)Since version 7.12.0

Setter for the font family.

Params:

Name	Type	Default	Description
fontFamily	string	'Helvetica Neue','Helvetica',sans-serif	Font family.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

fontOpacity

fontOpacity()Since version 7.12.0

Getter for the font opacity.

Returns:

number - Text font opacity.

See listing

var names = resourceList.names();
var opacity = names.fontOpacity();

fontOpacity(opacity)Since version 7.12.0

Setter for the font opacity.

Params:

Name	Type	Default	Description
opacity	number	1	Font opacity.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

Name	Type	Default	Description
size	string \| number	17	Font size.

fontStyle

fontStyle()Since version 7.12.0

Getter for the font style.

Returns:

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

See listing

var names = resourceList.names();
var style = names.fontStyle();

fontStyle(style)Since version 7.12.0

Setter for the font style.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

fontVariant

fontVariant()Since version 7.12.0

Getter for the font variant.

Returns:

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

See listing

var names = resourceList.names();
var variant = names.fontVariant();

fontVariant(type)Since version 7.12.0

Setter for the font variant.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()Since version 7.12.0

Getter for the font weight.

Returns:

string | number - The font weight.

See listing

var names = resourceList.names();
var weight = names.fontWeight();

fontWeight(weight)Since version 7.12.0

Setter for the font weight.

Params:

Name	Type	Default	Description
weight	string \| number	'bold'	Font weight.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

hAlign

hAlign()Since version 7.12.0

Getter for the font horizontal align.

Returns:

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

See listing

var names = resourceList.names();
var hAlign = names.hAlign();

hAlign(align)Since version 7.12.0

Setter for the font horizontal align.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

letterSpacing

letterSpacing()Since version 7.12.0

Getter for the letter spacing.

Returns:

string | number - The letter spacing.

See listing

var names = resourceList.names();
var letterSpacing = names.letterSpacing();

letterSpacing(spacing)Since version 7.12.0

Setter for the letter spacing.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

lineHeight

lineHeight()Since version 7.12.0

Getter for the font line height.

Returns:

string | number - Line height.

See listing

var names = resourceList.names();
var lineHeight = names.lineHeight();

lineHeight(height)Since version 7.12.0

Setter for the font line height.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

margin

margin()Since version 7.12.0

Getter for the margin.

Returns:

anychart.core.utils.Margin - The margin.

Try it:

Usage sample

margin(margin)Since version 7.12.0

Setter for the margin using a single value.

Params:

Name	Type	Description
margin	Array.<(number\|string)> \| Object	Margin to set.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

margin(value1, value2, value3, value4)Since version 7.12.0

Setter for the callout margin using several values.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

padding

padding()Since version 7.12.0

Getter for tags padding.

Returns:

anychart.core.utils.Padding - Tags padding.

Try it:

Usage sample

padding(padding)Since version 7.12.0

Setter for padding in pixels by one value.

Params:

Name	Type	Description
padding	Array.<(number\|string)> \| Object	Padding to set.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

padding(value1, value2, value3, value4)Since version 7.12.0

Setter for tags padding in pixels.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Example

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

Try it:

Usage sample

selectable

selectable()Since version 7.12.0

Getter for the text selectable.

Returns:

boolean - The text selectable option.

See listing

var names = resourceList.names();
var selectable = names.selectable();

selectable(enabled)Since version 7.12.0

Setter for the text selectable.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

textDirection

textDirection()Since version 7.12.0

Getter for the text direction.

Returns:

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

See listing

var names = resourceList.names();
var textDirection = names.textDirection();

textDirection(type)Since version 7.12.0

Setter for the text direction.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

textIndent

textIndent()Since version 7.12.0

Getter for text indent settings.

Returns:

number - Text indent.

See listing

var names = resourceList.names();
var textIndent = names.textIndent();

textIndent(indent)Since version 7.12.0

Setter for text indent settings.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

textOverflow

textOverflow()Since version 7.12.0

Getter for text overflow settings.

Returns:

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

See listing

var names = resourceList.names();
var textOverflow = names.textOverflow();

textOverflow(value)Since version 7.12.0

Setter for text overflow settings.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

useHtml

useHtml()Since version 7.12.0

Getter for the useHTML flag.

Returns:

boolean - UseHTML flag.

See listing

var names = resourceList.names();
var useHtmlFlag = names.useHtml();

useHtml(enabled)Since version 7.12.0

Setter for the useHTML flag.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

vAlign

vAlign()Since version 7.12.0

Getter for the font vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Font vertical align.

See listing

var names = resourceList.names();
var vAlign = names.vAlign();

vAlign(align)Since version 7.12.0

Setter for the font vertical align.

Params:

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

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

Try it:

Usage sample

wordBreak

wordBreak()Since version 8.0.0

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.

See listing

var resourceList = chart.resourceList();
var names = resourceList.names();
var wordBreak = names.wordBreak();

wordBreak(mode)Since version 8.0.0

Setter for the word-break mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordBreak \| string	'normal'	Value to set.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

See listing

var resourceList = chart.resourceList();
var names = resourceList.names();
var wordBreak = names.wordBreak();

wordWrap

wordWrap()Since version 8.0.0

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.

See listing

var resourceList = chart.resourceList();
var names = resourceList.names();
var wordWrap = names.wordWrap();

wordWrap(mode)Since version 8.0.0

Setter for the word-wrap mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordWrap \| string	'normal'	Value to set.

Returns:

anychart.core.resource.resourceList.TagsSettings - Self instance for method chaining.

See listing

var resourceList = chart.resourceList();
var names = resourceList.names();
names.wordWrap("break-word");

class anychart.core.resource.resourceList.TagsSettings Improve this Doc

Methods Overview

Methods Description

background

disablePointerEvents

fontColor

fontDecoration

fontFamily

fontOpacity

fontSize

fontStyle

fontVariant

fontWeight

hAlign

letterSpacing

lineHeight

margin

padding

selectable

textDirection

textIndent

textOverflow

useHtml

vAlign

wordBreak

wordWrap