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, 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
labels()Labels settings.
lowerLabels()Labels settings.
size()Marker size settings.
type()Marker type.
upperLabels()Labels settings.
whiskerWidth()Whisker width.
Coloring
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.
highStroke()High stroke 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
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
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state settings.
Point Elements
headers()Header labels settings.
markers()Markers settings.
outlierMarkers()Outlier markers settings.
Text Settings
fontFamily()Font family setting.
fontSize()Font size settings.
fontStyle()Font style settings.
fontVariant()Font variant settings.
fontWeight()Text font weight settings.

Methods Description

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:

Name Type Default Description
fillFunction function
// 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 myFill; //anychart.graphics.vector.Fill };.

Returns:

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

Try it:

Setter for the dummy fill. Learn more about coloring.

Params:

Name Type Description
fillOrColorOrKeys anychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | null Color as an object or a string or function.
opacityOrAngleOrCx number X ratio of center radial gradient.
modeOrCy number | boolean | anychart.math.Rect | Object If defined then userSpaceOnUse mode, else objectBoundingBox, or Y ratio of center radial gradient.
opacityOrMode number | anychart.math.Rect | Object | null Opacity. If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Color opacity.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

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:

Name Type Default Description
strokeFunction function
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.

Try it:

Setter for tasks dummy stroke. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

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 a string or an object. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill | string Color 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:

Name Type Default Description
fillFunction function
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.

Try it:

State fill color with opacity for the empty part of a tank. Fill as a string or an object.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

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:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

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

Try it:

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:

Name Type Default Description
value anychart.graphics.vector.Fill
null
Color as an object or a string.

Returns:

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

Params:

Name Type Default Description
fillFunction function
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.

Try it:

Falling fill color with opacity.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient falling fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient falling fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Image falling fill. Learn more about coloring.

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

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:

Name Type Default Description
patternFillOrTypeOrState anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
null
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

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

Try it:

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:

Name Type Default Description
fillFunction function
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.

Try it:

Setter for falling stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
stroke anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

fill

Getter for the fill.

Returns:

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

Params:

Name Type Default Description
fillFunction function
// 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 myFill; //anychart.graphics.vector.Fill };.

Returns:

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

Try it:

Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an array or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

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:

Name Type Default Description
value string
"Verdana, Helvetica, Arial, sans-serif"
Font family.

Returns:

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

Try it:

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:

Name Type Description
value number | string Value to set.

Returns:

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

Try it:

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:

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

Returns:

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

Try it:

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:

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

Returns:

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

Try it:

fontWeight

Getter for the text font weight.

Returns:

string number - Font weight.
See listing
var state = chart.normal();
var fontWeight = state.fontWeight();
Setter for the text font weight. https://www.w3schools.com/cssref/pr_font_weight.asp

Params:

Name Type Description
value string | number Value to set.

Returns:

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

Try it:

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:

Name Type Default Description
gridFunction function
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.

Try it:

Setter for annotation grid settings. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Grid settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

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:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string
false
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

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

Try it:

headers

Getter for the header labels (TreeMap).

Returns:

anychart.core.ui.LabelsFactory - Labels factory instance.

Try it:

Setter for the header labels (TreeMap).

Params:

Name Type Description
value Object | boolean | null Header labels labels.

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:

Name Type Default Description
strokeFunction function
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.

Try it:

Setter for high stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

hovered

Getter for the hovered state.

Returns:

anychart.core.StateSettings - State settings.
Setter for the hovered state.

Params:

Name Type Description
value Object State settings to set.

Returns:

object - Self instance for method chaining.

Try it:

labels

Setter for labels.

Params:

Name Type Description
value Object | boolean | null Labels settings.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

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

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

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:

Name Type Default Description
strokeFunction function
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.

Try it:

Setter for low stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

lowerLabels

Getter for lower labels (for pert tasks).

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for lower labels (for pert tasks).

Params:

Name Type Description
value Object | boolean | null Labels settings.

Returns:

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

markers

Getter for data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for data markers.

Params:

Name Type Default Description
value Object | boolean | null | string
false
Data markers 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:

Name Type Default Description
value function
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.

Try it:

Setter for median stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

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 or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

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

Params:

Name Type Default Description
fillFunction function
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.

Try it:

Negative fill color with opacity.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

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:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string
null
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

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

Try it:

negativeStroke

Getter for stroke settings.

Returns:

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

Params:

Name Type Default Description
strokeFunction function
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.

Try it:

Params:

Name Type Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null Stroke settings.
thickness number Line thickness.
dashpattern string Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

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

Try it:

normal

Getter for the normal state.

Returns:

anychart.core.StateSettings - State settings.
Setter for the normal state.

Params:

Name Type Description
value Object State settings to set.

Returns:

object - Self instance for method chaining.

Try it:

outlierMarkers

Getter for series outlier markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for series outlier markers.

Params:

Name Type Default Description
value Object | boolean | null | string
true
Series outlier markers header labels.

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:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

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 or a string. Learn more about hatch fill settings.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

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

Params:

Name Type Default Description
fillFunction function
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.

Try it:

Rising fill color with opacity.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.

Try it:

Linear gradient rising fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.

Try it:

Radial gradient rising fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Image rising fill. Learn more about coloring.

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

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:

Name Type Default Description
patternFillOrTypeOrState anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
null
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

anychart.core.stock.scrollerSeries.Base - Self instance for method chaining.

Try it:

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:

Name Type Default Description
strokeFunction function
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.

Try it:

Setter for rising stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

selected

Getter for the selected state.

Returns:

anychart.core.StateSettings - State settings.
Setter for the selected state.

Params:

Name Type Description
value Object State settings to set.

Returns:

object - Self instance for method chaining.

Try it:

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:

Name Type Description
value number Value to set.

Returns:

anychart.core.polar.series.Marker - Self instance for method chaining.

Try it:

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:

Name Type Default Description
value function
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.

Try it:

Setter for stem stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

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:

Name Type Default Description
strokeFunction function
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.

Try it:

Setter for stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

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:

Name Type Default Description
trendFunction function
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.

Try it:

Setter for annotation trend settings. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Trend settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

type

Getter for the marker type.

Returns:

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

Params:

Name Type Default Description
value string | anychart.enums.MarkerType | 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:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

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

Returns:

boolean - Whether any listener was removed.

Try it:

upperLabels

Getter for upper labels (for pert tasks).

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for upper labels (for pert tasks).

Params:

Name Type Description
value Object | boolean | null Labels settings.

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:

Name Type Default Description
value function
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.

Try it:

Setter for whisker stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

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:

Name Type Default Description
value number | string
0
Whisker width.

Returns:

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

Try it: