AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.StateSettings Improve this Doc

Extends: anychart.core.Base

The StateSettings class contains methods for configuring the states of different charts and their parts.
States are used for series, charts, annotations, buttons, intersections in Venn Diagram, pointers in Linear Gauge, tasks, and milestones in PERT Chart, activities in Resource Chart.
See examples below:

Methods Overview

Specific settings
content()Content settings.
labels()Labels settings.
lowerLabels()Labels settings.
outline()Outline settings.
size()Marker size settings.
type()Marker type.
upperLabels()Labels settings.
whiskerWidth()Whisker width.
Advanced Text Settings
letterSpacing()Letter spacing settings.
lineHeight()Line height settings.
textIndent()Text indent settings.
textOverflow()Text overflow settings.
useHtml()Text useHtml settings.
wordBreak()Word break mode.
wordWrap()Word-wrap mode.
Coloring
background()Background settings.
dummyFill()Fill settings.
dummyStroke()Stroke settings.
emptyFill()Fill settings.
emptyHatchFill()Hatch fill settings.
fallingFill()Falling fill settings.
fallingHatchFill()Falling hatch fill settings.
fallingStroke()Falling stroke settings.
fill()Fill settings.
grid()Grid settings.
hatchFill()Hatch fill settings.
highFill()High fill settings.
highHatchFill()High hatch fill settings.
highStroke()High stroke settings.
lowFill()Low fill settings.
lowHatchFill()Low hatch fill settings.
lowStroke()Low stroke settings.
medianStroke()Median stroke settings.
negativeFill()Negative fill settings.
negativeHatchFill()Negative hatch fill settings.
negativeStroke()Negative stroke settings.
risingFill()Rising fill settings.
risingHatchFill()Rising hatch fill settings.
risingStroke()Rising stroke settings.
stemStroke()Stem stroke settings.
stroke()Stroke settings.
trend()Trend settings.
whiskerStroke()Whisker settings.
Events
disablePointerEvents()Disable 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.
Interactivity
selectable()Text selectable option.
Point Elements
headers()Header labels settings.
markers()Markers settings.
maxLabels()Maximum labels settings.
minLabels()Minimum labels settings.
outlierMarkers()Outlier markers settings.
Size and Position
connector()Connector settings.
explode()Explode radius settings.
fontPadding()Font padding settings.
height()Markers height in pixels or percentages.
width()Markers width in pixels or percentages.
States
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state settings.
Text Settings
adjustFontSize()Adjusting settings.
fontColor()Font color settings.
fontDecoration()Font decoration settings.
fontFamily()Font family setting.
fontOpacity()Font opacity settings.
fontSize()Font size settings.
fontStyle()Font style settings.
fontVariant()Font variant settings.
fontWeight()Text font weight settings.
hAlign()Horizontal align settings.
textDirection()Letter direction settings.
vAlign()Vertical align settings.

Methods Description

adjustFontSize

Getter for the adjusting font size.

Returns:

number - An adjusted font size.
See listing
var adjustFontSize = normal.adjustFontSize();
Setter for the adjusting font size.

Params:

NameTypeDefaultDescription
adjustOrAdjustByWidthboolean | Array.<boolean> | Object
true
Font needs to be adjusted in case of 1 argument and adjusted by width in case of 2 arguments.
adjustByHeightboolean
Font needs to be adjusted by height.

Returns:

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

background

Getter for the background.

Returns:

anychart.core.ui.Background - Background instance.
Setter for the background settings.

Params:

NameTypeDescription
settingsstring | Object | null | booleanBackground settings to set.

Returns:

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

connector

Getter for connector settings (for stock event markers).

Returns:

anychart.core.utils.Connector - Connector settings.
Setter for the connector settings (for stock event markers).

Params:

NameTypeDescription
settingsObjectConnector to set.

Returns:

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

content

Getter for buttons content settings.

Returns:

string | number - Buttons content.
See listing
var state = buttons.normal();
var content = state.content();
Setter for buttons content settings.

Params:

NameTypeDescription
contentstring | numberButtons content.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for buttons content settings using function.

Params:

NameTypeDescription
functionfunction(path:anychart.graphics.vector.Path)Buttons content. Function that looks like:
function(){
   // this.path - button element, instance of anychart.graphics.vector.Path
   // this.width - button width (number).
   // this.height - button height (number).
   // this.state - button state: normal, hovered or selected (string).
}

Returns:

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

disablePointerEvents

Getter for the state of disablePointerEvents option.

Returns:

boolean - If pointer events are disabled.
See listing
var state = buttons.normal();
var disablePointerEvents = state.disablePointerEvents();
Setter for the text disablePointerEvents option.

Params:

NameTypeDefaultDescription
enabledboolean
false
Value to set.

Returns:

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

dummyFill

Getter for the dummy fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.
See listing
var state = tasks.normal();
var dummyFill = state.dummyFill();
Setter for the dummy fill using function. Learn more about coloring.

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
// return the fill from the default palette.
function() {
  return this.sourceColor;
};
Fill-function, which should look like this:
function() {
 //  this: {
 //  index : number  - the index of the current point
 //  sourceColor : anychart.graphics.vector.Fill - fill of the current point
 // }
 return fillValue; //anychart.graphics.vector.Fill
};

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for dummy fill settings using a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.FillColor as a string.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Dummy fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Linear gradient dummy fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Radial gradient dummy fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Image dummy fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

dummyStroke

Getter for tasks dummy stroke.

Returns:

anychart.graphics.vector.Stroke - The milestones stroke.
See listing
var state = tasks.normal();
var dummyStroke = state.dummyStroke();
Setter for tasks dummy stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor -  color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for tasks dummy stroke. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for tasks dummy stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

emptyFill

Getter for the state fill color for the empty part of a tank.

Returns:

anychart.graphics.vector.Fill | function - The fill color.
See listing
var normal = tank.normal();
var emptyFill = normal.emptyFill();
Setter for state fill settings for the empty part of a tank using an object and a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for state fill settings for the empty part of a tank using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
State fill color with opacity for the empty part of a tank. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

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

emptyHatchFill

Getter for hatch fill settings.
See listing
var normal = tank.normal();
var emptyHatchFill = normal.emptyHatchFill();
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
false
Type of the hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

explode

Getter for the explode radius (for Pie chart).

Returns:

number | string - Explode radius.
See listing
var selected = chart.selected();
var explode = selected.explode();
Setter for the explode radius (for Pie chart).

Params:

NameTypeDefaultDescription
explodenumber | string
0 for the normal state, 0 for the hovered state, '7%' for the selected state
Explode radius in pixel/percent.

Returns:

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

fallingFill

Getter for the falling fill color.

Returns:

anychart.graphics.vector.Fill - Falling fill color.
See listing
var normal = series.normal();
var fallingFill = normal.fallingFill();
Setter for falling fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
null
Color as an object, an array or a string.

Returns:

anychart.core.cartesian.series.Base - Self instance for method chaining.
Setter for falling fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Falling fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

anychart.core.cartesian.series.Base - Self instance for method chaining.
Linear gradient falling fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.cartesian.series.Base - Self instance for method chaining.
Radial gradient falling fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.cartesian.series.Base - Self instance for method chaining.
Image falling fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.cartesian.series.Base - Self instance for method chaining.

fallingHatchFill

Getter for falling hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Falling hatch fill settings.
See listing
var normal = series.normal();
var fallingHatchFill = normal.fallingHatchFill();
Setter for falling hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
null
Type of the hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.cartesian.series.Base - Self instance for method chaining.
Setter for falling hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for falling hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for falling hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for falling hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

fallingStroke

Getter for falling stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Falling stroke settings.
See listing
var normal = series.normal();
var fallingStroke = normal.fallingStroke();
Setter for falling stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for falling stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
strokeanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for falling stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

fill

Getter for the fill.

Returns:

anychart.graphics.vector.Fill | function():anychart.graphics.vector.Fill - Fill settings.
See listing
var normal = chart.normal();
var fill = normal.fill();
Setter for the fill. Learn more about coloring.

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
// return the fill from the default palette.
function() {
  return this.sourceColor;
};
Fill-function, which should look like this:
function() {
 //  this: {
 //  index : number  - the index of the point
 //  sourceColor : anychart.graphics.vector.Fill - fill of the point
 // }
 return fillValue; //anychart.graphics.vector.Fill
};

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an array, an object or a string.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for the fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for the linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for the radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for the image fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

fontColor

Getter for font color settings.

Returns:

string - Font color settings.
See listing
var state = annotation.normal();
var fontColor = state.fontColor();
Setter for font color settings.

Params:

NameTypeDescription
colorstringFont color to set.

Returns:

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

fontDecoration

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - Font decoration.
See listing
var state = annotation.normal();
var fontDecoration = state.fontDecoration();
Setter for the text font decoration.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.Decoration | string
anychart.graphics.vector.Text.Decoration#NONE
Font decoration to set.

Returns:

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

fontFamily

Getter for the font family of text.

Returns:

string - Font family.
See listing
var state = chart.normal();
var fontFamily = state.fontFamily();
Setter for the font family of text.

Params:

NameTypeDefaultDescription
familystring
'Verdana, Helvetica, Arial, sans-serif'
Font family.

Returns:

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

fontOpacity

Getter for the text font opacity.

Returns:

number - Font opacity.
See listing
var state = annotation.normal();
var fontOpacity = state.fontOpacity();
Setter for the text font opacity.
Double value from 0 to 1.

Params:

NameTypeDescription
opacitynumberFont opacity to set.

Returns:

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

fontPadding

Getter for the font padding.

Returns:

number | string - Font padding.
See listing
var normal = eventMarkers.normal();
var fontPadding = normal.fontPadding();
Setter for the font padding.

Params:

NameTypeDefaultDescription
paddingnumber | string
0
Font padding to set.

Returns:

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

fontSize

Getter for font size settings.

Returns:

number - Font size settings.
See listing
var state = chart.normal();
var fontSize = state.fontSize();
Setter for font size settings.

Params:

NameTypeDescription
sizenumber | stringFont size to set.

Returns:

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

fontStyle

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.
See listing
var state = chart.normal();
var fontStyle = state.fontStyle();
Setter for the text font style.

Params:

NameTypeDescription
styleanychart.graphics.vector.Text.FontStyle | stringFont style to set.

Returns:

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

fontVariant

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - Font variant.
See listing
var state = chart.normal();
var fontVariant = state.fontVariant();
Setter for the text font variant.

Params:

NameTypeDescription
valueanychart.graphics.vector.Text.FontVariant | stringFont variant to set.

Returns:

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

fontWeight

Getter for the text font weight.

Returns:

string | number - Font weight.
See listing
var state = chart.normal();
var fontWeight = state.fontWeight();

Params:

NameTypeDescription
weightstring | numberFont weight to set.

Returns:

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

grid

Getter for annotation grid settings.

Returns:

anychart.graphics.vector.Stroke - Grid settings.
See listing
var normal = annotation.normal();
var grid = normal.grid();
Setter for the annotation grid by function.

Params:

NameTypeDefaultDescription
gridFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for annotation grid settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Grid settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

hAlign

Getter for the button text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.
See listing
var state = buttons.normal();
var hAlign = state.hAlign();
Setter for the button text horizontal align.

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.HAlign | string
anychart.graphics.vector.Text.HAlign#START
Horizontal align to set.

Returns:

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

hatchFill

Getter for hatch fill settings.
See listing
var normal = series.normal();
var hatchFill = normal.hatchFill();
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
false
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

headers

Getter for the header labels (TreeMap).

Returns:

anychart.core.ui.LabelsFactory - Labels factory instance.
Setter for the header labels (TreeMap).

Params:

NameTypeDescription
settingsObject | boolean | nullHeader labels labels.

Returns:

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

height

Getter for the event markers height.

Returns:

string | number - Markers height.
See listing
var height = normal.height();
Setter for the markers height.

Params:

NameTypeDefaultDescription
heightstring | number
20
Height to set.

Returns:

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

highFill

Getter for the high fill color (for the range series and Hilo series).

Returns:

anychart.graphics.vector.Fill - The low fill color.
See listing
var normal = series.normal();
var highFill = normal.highFill();
Setter for the high fill settings using an array, an object or a string (for the range series and Hilo series). Learn more about hatch fill settings.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Setter for the high fill settings using function (for the range series and Hilo series).

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
High fill color with opacity (for the range series and Hilo series).

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Linear gradient high fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Radial gradient high fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Image high fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

highHatchFill

Getter for high hatch fill settings (for the range series and Hilo series).
See listing
var normal = series.normal();
var highHatchFill = normal.highHatchFill();
Setter for high hatch fill settings (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringHatch fill type.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for high hatch fill settings using function (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
functionfunctionHatchFill function.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for high hatch fill settings using pattern fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for high hatch fill settings using an instance (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

highStroke

Getter for high stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - High stroke settings.
See listing
var normal = series.normal();
var highStroke = normal.highStroke();
Setter for high stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for high stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

hovered

Getter for the hovered state.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for the hovered state.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

Object - Self instance for method chaining.

labels

Setter for labels.

Params:

NameTypeDescription
settingsObject | boolean | nullLabels settings.

Returns:

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

letterSpacing

Getter for the button text letter spacing.

Returns:

string | number - Letter spacing.
See listing
var state = buttons.normal();
var letterSpacing = state.letterSpacing();
Setter for the button text letter spacing. https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

NameTypeDescription
spacingstring | numberText letter spacing to set.

Returns:

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

lineHeight

Getter for the button text line height.

Returns:

string | number - Text line height.
See listing
var state = buttons.normal();
var lineHeight = state.lineHeight();
Setter for the button text line height. https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

NameTypeDescription
heightstring | numberLine height to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

lowFill

Getter for the series low fill color (for the range series and Hilo series).

Returns:

anychart.graphics.vector.Fill - The low fill color.
See listing
var normal = series.normal();
var lowFill = normal.lowFill();
Setter for the low fill settings using an array, an object or a string (for the range series and Hilo series). Learn more about hatch fill settings.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Setter for the low fill settings using function (for the range series and Hilo series).

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Low fill color with opacity (for the range series and Hilo series).

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Linear gradient low fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Radial gradient low fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Image low fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

lowHatchFill

Getter for low hatch fill settings (for the range series and Hilo series).
See listing
var normal = series.normal();
var lowHatchFill = normal.lowHatchFill();
Setter for low hatch fill settings (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringType of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for low hatch fill settings using function (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
functionfunctionHatchFill function.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for low hatch fill settings using pattern fill (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for low hatch fill settings using an instance (for the range series and Hilo series). Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

lowStroke

Getter for low stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Stroke settings.
See listing
var normal = series.normal();
var lowStroke = normal.lowStroke();
Setter for low stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for low stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for low stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

lowerLabels

Getter for lower labels (for pert tasks).

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for lower labels (for pert tasks).

Params:

NameTypeDescription
settingsObject | boolean | nullLabels settings.

Returns:

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

markers

Getter for data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.
Setter for data markers.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null | string
false
Data markers settings.

Returns:

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

maxLabels

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for maximum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMaximum labels settings.

Returns:

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

medianStroke

Getter for median stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Median stroke settings.
See listing
var normal = series.normal();
var medianStroke = normal.medianStroke();
Setter for the median stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor -  color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for median stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for median stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

minLabels

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for minimum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMinimum labels settings.

Returns:

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

negativeFill

Getter for the series negative fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.
See listing
var normal = series.normal();
var negativeFill = normal.negativeFill();
Setter for negative fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for negative fill settings using function. Learn more about coloring.

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Negative fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

negativeHatchFill

Getter for negative hatch fill settings.
See listing
var normal = series.normal();
var negativeHatchFill = normal.negativeHatchFill();
Setter for negative hatch fill settings. Learn more about coloring.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
null
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for negative hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for negative hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for negative hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for negative hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

negativeStroke

Getter for negative stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Stroke settings.
See listing
var normal = series.normal();
var negativeStroke = normal.negativeStroke();
Setter for negative stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor -  color returned by stroke() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
}

Returns:

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

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke settings.
thicknessnumberLine thickness.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join style.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for negative stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

normal

Getter for the normal state.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for the normal state.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

Object - Self instance for method chaining.

outlierMarkers

Getter for series outlier markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.
Setter for series outlier markers.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null | string
true
Series outlier markers header labels.

Returns:

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

outline

Getter for pie outline settings.

Returns:

anychart.core.ui.Outline - Outline settings
Setter for pie outline settings.

Params:

NameTypeDescription
settingsObjectOutline settings to set.

Returns:

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

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

risingFill

Getter for the series rising fill color.

Returns:

anychart.graphics.vector.Fill - The rising fill color.
See listing
var normal = series.normal();
var risingFill = normal.risingFill();
Setter for the rising fill settings using an array, an object or a string. Learn more about hatch fill settings.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | string | ArrayColor as an object, an array or a string.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Setter for the rising fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Rising fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Linear gradient rising fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Radial gradient rising fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Image rising fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

risingHatchFill

Getter for the rising hatch fill.
See listing
var normal = series.normal();
var risingHatchFill = normal.risingHatchFill();
Setter for rising hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
null
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.
Setter for rising hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for rising hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for rising hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for rising hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

risingStroke

Getter for rising stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Stroke settings.
See listing
var normal = series.normal();
var risingStroke = normal.risingStroke();
Setter for series rising stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for rising stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for rising stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

selectable

Getter for the text selectable option.

Returns:

boolean - Text selectable option.
See listing
var state = buttons.normal();
var textOverflow = state.selectable();
Setter for the text selectable.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

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

selected

Getter for the selected state.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for the selected state.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

Object - Self instance for method chaining.

size

Getter for the marker size.

Returns:

number - Marker size.
See listing
var normal = series.normal();
var size = normal.size();
Setter for the marker size.

Params:

NameTypeDescription
sizenumberMarker size to set.

Returns:

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

stemStroke

Getter for stem stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Stem stroke settings.
See listing
var normal = series.normal();
var stemStroke = normal.stemStroke();
Setter for the stem stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor -  color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for stem stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for stem stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

stroke

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing
var normal = series.normal();
var stroke = normal.stroke();
Setter for stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by stroke() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

textDirection

Getter for the button text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Text direction.
See listing
var state = buttons.normal();
var textDirection = state.textDirection();
Setter for the button text direction.

Params:

NameTypeDefaultDescription
directionanychart.graphics.vector.Text.Direction | string
anychart.graphics.vector.Text.Direction#LTR
Text direction to set.

Returns:

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

textIndent

Getter for the button text indent.

Returns:

number - Text indent.
See listing
var state = buttons.normal();
var textIndent = state.textIndent();
Setter for the button text indent.

Params:

NameTypeDescription
indentnumberText indent to set.

Returns:

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

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.
See listing
var state = buttons.normal();
var textOverflow = state.textOverflow();
Setter for the text overflow settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.TextOverflow | string
anychart.graphics.vector.Text.TextOverflow#CLIP
Value to set.

Returns:

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

trend

Getter for annotation trend settings.

Returns:

anychart.graphics.vector.Stroke - Trend settings.
See listing
var normal = annotation.normal();
var trend = normal.trend();
Setter for the annotation trend by function.

Params:

NameTypeDefaultDescription
trendFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for annotation trend settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Trend settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

type

Getter for the marker type.

Returns:

anychart.enums.MarkerType | string | function - Markers type settings.
See listing
var normal = series.normal();
var type = normal.type();
Setter for the marker type.

Params:

NameTypeDefaultDescription
typeanychart.enums.MarkerType | string | function
'circle'
Type or custom drawer. Function for a custom marker should look like this:
function(path, x, y, size){
   // path - anychart.graphics.vector.Path
   // x, y - marker position
   // size - marker size
   ... //do something
   return path;
 }

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

upperLabels

Getter for upper labels (for pert tasks).

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for upper labels (for pert tasks).

Params:

NameTypeDescription
settingsObject | boolean | nullLabels settings.

Returns:

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

useHtml

Getter for the useHtml flag.

Returns:

boolean - Boolean flag.
See listing
var state = buttons.normal();
var useHtml = state.useHtml();
Setter for flag useHtml.

Params:

NameTypeDefaultDescription
enabledboolean
false
Value to set.

Returns:

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

vAlign

Getter for the button text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Text vertical align.
See listing
var state = buttons.normal();
var vAlign = state.vAlign();
Setter for the button text vertical align.

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.VAlign | string
anychart.graphics.vector.Text.VAlign#TOP
Vertical align to set.

Returns:

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

whiskerStroke

Getter for whisker stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Whisker stroke settings.
See listing
var normal = series.normal();
var whiskerStroke = normal.whiskerStroke();
Setter for the whisker stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor -  color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for whisker stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.StateSettings - Self instance for method chaining.
Setter for whisker stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

whiskerWidth

Getter for the whisker width.

Returns:

number | string - Whisker width.
See listing
var normal = series.normal();
var whiskerWidth = normal.whiskerWidth();
Setter for the whisker width.

Params:

NameTypeDefaultDescription
widthnumber | string
0
Whisker width.

Returns:

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

width

Getter for the markers width.

Returns:

string | number - Markers width.
See listing
var width = normal.width();
Setter for the markers width.

Params:

NameTypeDefaultDescription
widthstring | number
20
Width to set.

Returns:

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

wordBreak

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.
See listing
var state = buttons.normal();
var wordBreak = state.wordBreak();
Setter for the word-break mode.

Params:

NameTypeDescription
modeanychart.enums.WordBreak | stringWord-break mode to set.

Returns:

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

wordWrap

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.
See listing
var state = buttons.normal();
var wordWrap = state.wordWrap();
Setter for the word-wrap mode.

Params:

NameTypeDescription
modeanychart.enums.WordWrap | stringWord-wrap mode to set.

Returns:

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