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. |
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. |
textShadow() | Text shadow settings. |
vAlign() | Vertical align settings. |
Methods Description
adjustFontSize
- [false, false] - do not adjust (adjust is off )
- [true, false] - adjust width
- [false, true] - adjust height
- [true, true] - adjust the first suitable value.
Returns:
number - An adjusted font size.var adjustFontSize = normal.adjustFontSize();
Note: anychart.core.StateSettings#fontSize does not work when adjusting is enabled.
Params:
Name | Type | Default | Description |
---|---|---|---|
adjustOrAdjustByWidth | boolean | Array.<boolean> | Object | true | Font needs to be adjusted in case of 1 argument and adjusted by width in case of 2 arguments. |
adjustByHeight | boolean | Font needs to be adjusted by height. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
background
- null/boolean - disable or enable background.
- object - sets background settings.
- string - sets background color.
Params:
Name | Type | Description |
---|---|---|
settings | string | Object | null | boolean | Background settings to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.connector
Returns:
anychart.core.utils.Connector - Connector settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Connector to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
content
Returns:
string | number - Buttons content.var state = buttons.normal(); var content = state.content();
Params:
Name | Type | Description |
---|---|---|
content | string | number | Buttons content. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
function | function(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.Try it:
disablePointerEvents
Returns:
boolean - If pointer events are disabled.var state = buttons.normal(); var disablePointerEvents = state.disablePointerEvents();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.dummyFill
Returns:
anychart.graphics.vector.Fill - Fill color.var state = tasks.normal(); var dummyFill = state.dummyFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | Color as a string. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
Returns:
anychart.core.StateSettings - Self instance for method chaining.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.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.Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.dummyStroke
Returns:
anychart.graphics.vector.Stroke - The milestones stroke.var state = tasks.normal(); var dummyStroke = state.dummyStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
emptyFill
Returns:
anychart.graphics.vector.Fill | function - The fill color.var normal = tank.normal(); var emptyFill = normal.emptyFill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
emptyHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | boolean - Hatch fill settings.var normal = tank.normal(); var emptyHatchFill = normal.emptyHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | false | Type of the hatch fill. |
color | string | Color. | |
thickness | number | Thickness. | |
size | number | Pattern size. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
explode
Returns:
number | string - Explode radius.var selected = chart.selected(); var explode = selected.explode();
Params:
Name | Type | Default | Description |
---|---|---|---|
explode | number | 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.Try it:
fallingFill
Returns:
anychart.graphics.vector.Fill - Falling fill color.var normal = series.normal(); var fallingFill = normal.fallingFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.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.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
Returns:
anychart.core.cartesian.series.Base - 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.cartesian.series.Base - 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.cartesian.series.Base - Self instance for method chaining.Try it:
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
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Falling hatch fill settings.var normal = series.normal(); var fallingHatchFill = normal.fallingHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | null | Type of the 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:
Params:
Name | Type | Description |
---|---|---|
hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fallingStroke
Returns:
anychart.graphics.vector.Stroke | function - Falling stroke settings.var normal = series.normal(); var fallingStroke = normal.fallingStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fill
var normal = chart.normal(); var fill = normal.fill();
Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
Params:
Name | Type | Description |
---|---|---|
color | anychart.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.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:
fontColor
Returns:
string - Font color settings.var state = annotation.normal(); var fontColor = state.fontColor();
Params:
Name | Type | Description |
---|---|---|
color | string | Font color to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontDecoration
Returns:
anychart.graphics.vector.Text.Decoration | string - Font decoration.var state = annotation.normal(); var fontDecoration = state.fontDecoration();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.Decoration | string | anychart.graphics.vector.Text.Decoration#NONE | Font decoration to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontFamily
Returns:
string - Font family.var state = chart.normal(); var fontFamily = state.fontFamily();
Params:
Name | Type | Default | Description |
---|---|---|---|
family | string | 'Verdana, Helvetica, Arial, sans-serif' | Font family. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontOpacity
Returns:
number - Font opacity.var state = annotation.normal(); var fontOpacity = state.fontOpacity();
Double value from 0 to 1.
Params:
Name | Type | Description |
---|---|---|
opacity | number | Font opacity to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontPadding
Returns:
number | string - Font padding.var normal = eventMarkers.normal(); var fontPadding = normal.fontPadding();
Params:
Name | Type | Default | Description |
---|---|---|---|
padding | number | string | 0 | Font padding to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontSize
Returns:
number - Font size settings.var state = chart.normal(); var fontSize = state.fontSize();
Params:
Name | Type | Description |
---|---|---|
size | number | string | Font size to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontStyle
Returns:
anychart.graphics.vector.Text.FontStyle | string - Font style.var state = chart.normal(); var fontStyle = state.fontStyle();
Params:
Name | Type | Description |
---|---|---|
style | anychart.graphics.vector.Text.FontStyle | string | Font style to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontVariant
Returns:
anychart.graphics.vector.Text.FontVariant | string - Font variant.var state = chart.normal(); var fontVariant = state.fontVariant();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Text.FontVariant | string | Font variant to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
fontWeight
Returns:
string | number - Font weight.var state = chart.normal(); var fontWeight = state.fontWeight();
Params:
Name | Type | Description |
---|---|---|
weight | string | number | Font weight to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
grid
Returns:
anychart.graphics.vector.Stroke - Grid settings.var normal = annotation.normal(); var grid = normal.grid();
Params:
Name | Type | Default | Description |
---|---|---|---|
gridFunction | function():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.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Grid settings. | |
thickness | number | 1 | Line thickness. |
dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
hAlign
Returns:
anychart.graphics.vector.Text.HAlign | string - Text horizontal align.var state = buttons.normal(); var hAlign = state.hAlign();
Params:
Name | Type | Default | Description |
---|---|---|---|
align | anychart.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
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.var normal = series.normal(); var hatchFill = normal.hatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | false | 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:
Params:
Name | Type | Description |
---|---|---|
hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
headers
Returns:
anychart.core.ui.LabelsFactory - Labels factory instance.Try it:
- null/boolean - disable or enable header labels.
- object - sets header labels settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Header labels labels. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.height
Returns:
string | number - Markers height.var height = normal.height();
Params:
Name | Type | Default | Description |
---|---|---|---|
height | string | number | 20 | Height to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
highFill
Returns:
anychart.graphics.vector.Fill - The low fill color.var normal = series.normal(); var highFill = normal.highFill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.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.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
Returns:
anychart.core.stock.scrollerSeries.Base - 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.stock.scrollerSeries.Base - 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:
highHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.var normal = series.normal(); var highHatchFill = normal.highHatchFill();
Params:
Name | Type | Description |
---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | Hatch fill type. |
color | string | Color. |
thickness | number | Thickness. |
size | number | Pattern size. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
function | function | HatchFill function. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.highStroke
Returns:
anychart.graphics.vector.Stroke | function - High stroke settings.var normal = series.normal(); var highStroke = normal.highStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
hovered
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
Object - Self instance for method chaining.Try it:
labels
Try it:
- null/boolean - disable or enable labels.
- object - sets labels settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Labels settings. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.letterSpacing
Returns:
string | number - Letter spacing.var state = buttons.normal(); var letterSpacing = state.letterSpacing();
Params:
Name | Type | Description |
---|---|---|
spacing | string | number | Text letter spacing to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
lineHeight
Returns:
string | number - Text line height.var state = buttons.normal(); var lineHeight = state.lineHeight();
Params:
Name | Type | Description |
---|---|---|
height | string | number | Line height to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.lowFill
Returns:
anychart.graphics.vector.Fill - The low fill color.var normal = series.normal(); var lowFill = normal.lowFill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.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.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
Returns:
anychart.core.stock.scrollerSeries.Base - 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.stock.scrollerSeries.Base - 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:
lowHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.var normal = series.normal(); var lowHatchFill = normal.lowHatchFill();
Params:
Name | Type | Description |
---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | 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:
Params:
Name | Type | Description |
---|---|---|
function | function | HatchFill function. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.lowStroke
Returns:
anychart.graphics.vector.Stroke | function - Stroke settings.var normal = series.normal(); var lowStroke = normal.lowStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
lowerLabels
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
- null/boolean - disable or enable lower labels.
- object - sets lower labels settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Labels settings. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.markers
- null/boolean - disable or enable markers.
- object - sets markers settings.
- string - sets markers type.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | Object | boolean | null | string | false | Data markers settings. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.maxLabels
- null/boolean - disable or enable maximum labels.
- object - sets maximum labels settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Maximum labels settings. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.medianStroke
Returns:
anychart.graphics.vector.Stroke | function - Median stroke settings.var normal = series.normal(); var medianStroke = normal.medianStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
minLabels
- null/boolean - disable or enable minimum labels.
- object - sets minimum labels settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Minimum labels settings. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.negativeFill
Returns:
anychart.graphics.vector.Fill - Fill color.var normal = series.normal(); var negativeFill = normal.negativeFill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.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.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
Note: Works only with anychart.core.StateSettings#displayNegative.
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
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
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.var normal = series.normal(); var negativeHatchFill = normal.negativeHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | null | 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:
Params:
Name | Type | Description |
---|---|---|
hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
negativeStroke
Returns:
anychart.graphics.vector.Stroke | function - Stroke settings.var normal = series.normal(); var negativeStroke = normal.negativeStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. |
thickness | number | Line thickness. |
dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. |
lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
normal
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
Object - Self instance for method chaining.Try it:
outlierMarkers
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
- null/boolean - disable or enable series outlier markers.
- string - sets series outlier markers type value.
- object - sets series outlier markers settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | Object | boolean | null | string | true | Series outlier markers header labels. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.outline
Params:
Name | Type | Description |
---|---|---|
settings | Object | Outline settings to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
risingFill
Returns:
anychart.graphics.vector.Fill - The rising fill color.var normal = series.normal(); var risingFill = normal.risingFill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | string | Array | Color as an object, an array or a string. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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.Try it:
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:
risingHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Rising hatch fill.var normal = series.normal(); var risingHatchFill = normal.risingHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | null | 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:
Params:
Name | Type | Description |
---|---|---|
hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
risingStroke
Returns:
anychart.graphics.vector.Stroke | function - Stroke settings.var normal = series.normal(); var risingStroke = normal.risingStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
selectable
Returns:
boolean - Text selectable option.var state = buttons.normal(); var textOverflow = state.selectable();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Enabled state to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.selected
Returns:
anychart.core.StateSettings - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
Object - Self instance for method chaining.Try it:
size
Returns:
number - Marker size.var normal = series.normal(); var size = normal.size();
Params:
Name | Type | Description |
---|---|---|
size | number | Marker size to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
stemStroke
Returns:
anychart.graphics.vector.Stroke | function - Stem stroke settings.var normal = series.normal(); var stemStroke = normal.stemStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
stroke
Returns:
anychart.graphics.vector.Stroke - Stroke settings.var normal = series.normal(); var stroke = normal.stroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Object with stroke settings from anychart.graphics.vector.Stroke |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
textDirection
Returns:
anychart.graphics.vector.Text.Direction | string - Text direction.var state = buttons.normal(); var textDirection = state.textDirection();
Params:
Name | Type | Default | Description |
---|---|---|---|
direction | anychart.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
Returns:
number - Text indent.var state = buttons.normal(); var textIndent = state.textIndent();
Params:
Name | Type | Description |
---|---|---|
indent | number | Text indent to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.textOverflow
Returns:
anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.var state = buttons.normal(); var textOverflow = state.textOverflow();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.TextOverflow | string | anychart.graphics.vector.Text.TextOverflow#CLIP | Value to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.textShadow
Returns:
string - String representation of text shadow.var state = annotation.normal(); var textShadow = state.textShadow();
Params:
Name | Type | Default | Description |
---|---|---|---|
textShadow | anychart.graphics.vector.TextShadow | string | 'none' | Text shadow to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
trend
Returns:
anychart.graphics.vector.Stroke - Trend settings.var normal = annotation.normal(); var trend = normal.trend();
Params:
Name | Type | Default | Description |
---|---|---|---|
trendFunction | function():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.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Trend settings. | |
thickness | number | 1 | Line thickness. |
dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
type
Returns:
anychart.enums.MarkerType | string | function - Markers type settings.var normal = series.normal(); var type = normal.type();
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.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.Try it:
upperLabels
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
- null/boolean - disable or enable upper labels.
- object - sets upper labels settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Labels settings. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.useHtml
Returns:
boolean - Boolean flag.var state = buttons.normal(); var useHtml = state.useHtml();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.vAlign
Returns:
anychart.graphics.vector.Text.VAlign | string - Text vertical align.var state = buttons.normal(); var vAlign = state.vAlign();
Params:
Name | Type | Default | Description |
---|---|---|---|
align | anychart.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
Returns:
anychart.graphics.vector.Stroke | function - Whisker stroke settings.var normal = series.normal(); var whiskerStroke = normal.whiskerStroke();
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.Try it:
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
whiskerWidth
Returns:
number | string - Whisker width.var normal = series.normal(); var whiskerWidth = normal.whiskerWidth();
Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | 0 | Whisker width. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
width
Returns:
string | number - Markers width.var width = normal.width();
Params:
Name | Type | Default | Description |
---|---|---|---|
width | string | number | 20 | Width to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.Try it:
wordBreak
Returns:
anychart.enums.WordBreak | string - Word-break mode.var state = buttons.normal(); var wordBreak = state.wordBreak();
Params:
Name | Type | Description |
---|---|---|
mode | anychart.enums.WordBreak | string | Word-break mode to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.wordWrap
Returns:
anychart.enums.WordWrap | string - Word-wrap mode.var state = buttons.normal(); var wordWrap = state.wordWrap();
Params:
Name | Type | Description |
---|---|---|
mode | anychart.enums.WordWrap | string | Word-wrap mode to set. |
Returns:
anychart.core.StateSettings - Self instance for method chaining.