Top
You are looking at an outdated 7.5.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

class anychart.core.utils.Error Improve this Doc

Extends: anychart.core.Base

Class representing series error.

Methods Overview

Miscellaneous
mode()Getter for error mode.
valueError()Getter for value error.
valueErrorStroke()Getter for current value error stroke settings.
valueErrorWidth()Getter for current value error width settings.
valueLowerError()Getter for value lower error.
valueUpperError()Getter for value upper error.
xError()Getter for X error.
xErrorStroke()Getter for current X error stroke settings.
xErrorWidth()Getter for current X error width settings.
xLowerError()Getter for X lower error.
xUpperError()Getter for X upper error.

Methods Description

mode

Getter for error mode.

Returns:

anychart.enums.ErrorMode string - Returns current error mode.

Try it:

Setter for error mode.
Error mode defines the rule to parse values for series with error.

Params:

Name Type Default Description
value string | anychart.enums.ErrorMode
'both'
Value to set.

Returns:

anychart.core.utils.Error - Self instance for method chaining.
Sets error mode.

Params:

Name Type Description
value string value.

Returns:

anychart.enums.ErrorMode anychart.core.utils.Error - Error mode or self for chaining.

valueError

Getter for value error.

Returns:

string number - Returns current value error.

Try it:

Setter for value error.

Params:

Name Type Default Description
value string | number
null
Value error to set.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

valueErrorStroke

Getter for current value error stroke settings.

Returns:

anychart.graphics.vector.Stroke - Current stroke settings.

Try it:

Setter for current value error stroke settings.

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.Fill or anychart.graphics.vector.Stroke }.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

Setter for current value error stroke settings.

Params:

Name Type Default Description
strokeOrFill anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
'#1D8BD1'
Fill settings or 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 joint style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

valueErrorWidth

Getter for current value error width settings.

Returns:

number - Returns current value error width.

Try it:

Setter for value error width settings. Length pins for value axis in pixels.

Params:

Name Type Default Description
value number
10
Value error width.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

valueLowerError

Getter for value lower error.

Returns:

string number undefined - Returns current value lower error.

Try it:

Setter for value lower error.

Params:

Name Type Default Description
value string | number
undefined
Value lower error to set.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

valueUpperError

Getter for value upper error.

Returns:

string number undefined - Returns current value lower error.

Try it:

Setter for value upper error.

Params:

Name Type Default Description
value string | number
undefined
Value upper error to set.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

xError

Getter for X error.

Returns:

string number - Returns current X error.

Try it:

Setter for X error.

Params:

Name Type Default Description
value string | number
null
X Error to set.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

xErrorStroke

Getter for current X error stroke settings.

Returns:

anychart.graphics.vector.Stroke - Current stroke settings.

Try it:

Setter for current X error 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.Fill or anychart.graphics.vector.Stroke }.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

Setter for current X error stroke settings. Learn more about coloring.

Params:

Name Type Default Description
strokeOrFill anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
'#1D8BD1'
Fill settings or 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 joint style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

xErrorWidth

Getter for current X error width settings.

Returns:

number - Returns current X error width.

Try it:

Setter for X error width settings. Length pins for X axis in pixels.

Params:

Name Type Default Description
value number
10
X error width.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

xLowerError

Getter for X lower error.

Returns:

string number undefined - Returns current X lower error.

Try it:

Setter for X lower error.

Params:

Name Type Default Description
value string | number
undefined
X lower error to set.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it:

xUpperError

Getter for X upper error.

Returns:

string number undefined - Returns current X upper error.

Try it:

Setter for X upper error.

Params:

Name Type Default Description
value string | number
undefined
X upper error to set.

Returns:

anychart.core.utils.Error - Self instance for method chaining.

Try it: