AnyChart
API Reference
Still have questions?
Contact support
    Top

    class anychart.core.utils.Error Improve this Doc

    Extends: anychart.core.Base

    Class representing series error.
    Learn more about error chart.

    Methods Overview

    Specific settings
    mode()Error mode settings.
    valueError()Value error settings.
    valueErrorWidth()Value width settings.
    valueLowerError()Value lower error settings.
    valueUpperError()Value upper error settings.
    xError()X-error settings.
    xErrorWidth()X-error width settings.
    xLowerError()X lower error settings.
    xUpperError()X upper error settings.
    Coloring
    valueErrorStroke()Value error stroke settings.
    xErrorStroke()X-error stroke settings.

    Methods Description

    mode

    mode()

    Getter for error mode.

    Returns:

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

    Try it:

    mode(mode)

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

    Params:

    NameTypeDefaultDescription
    modeanychart.enums.ErrorMode | string
    'both'
    		 Value to set.

    Returns:

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

    Try it:

    valueError

    valueError()

    Getter for value error.

    Returns:

    string | number - Returns value error.

    Try it:

    valueError(valueError)

    Setter for value error.

    Params:

    NameTypeDefaultDescription
    valueErrorstring | number
    null
    		 Value error to set.

    Returns:

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

    Try it:

    valueErrorStroke

    valueErrorStroke()

    Getter for value error stroke settings.

    Returns:

    anychart.graphics.vector.Stroke - Stroke settings.

    Try it:

    valueErrorStroke(strokeFunction)

    Setter for value error stroke using a function.

    Params:

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

    Returns:

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

    Try it:

    valueErrorStroke(color, thickness, dashpattern, lineJoin, lineCap)

    Setter for value error stroke settings.

    Params:

    NameTypeDefaultDescription
    coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
    '#1D8BD1'
    		 Stroke settings.
    thicknessnumber
    1
    		 Line thickness.
    dashpatternstring
    		Controls the pattern of dashes and gaps used to stroke paths.
    lineJoinstring | anychart.graphics.vector.StrokeLineJoin
    		Line joint style.
    lineCapstring | anychart.graphics.vector.StrokeLineCap
    		Line cap style.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    valueErrorWidth
    valueErrorWidth()
    Getter for value error width settings.
    Returns:
    number - Returns value error width.
    Try it:
    valueErrorWidth(width)
    Setter for value error width settings. Length pins for value axis in pixels.
    Params:
    NameTypeDefaultDescription
    widthnumber
    10
    		 Value error width.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    valueLowerError
    valueLowerError()
    Getter for value lower error.
    Returns:
    string | number | undefined - Returns value lower error.
    Try it:
    valueLowerError(valueLowerError)
    Setter for value lower error.
    Params:
    NameTypeDefaultDescription
    valueLowerErrorstring | number
    null
    		 Value lower error to set.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    valueUpperError
    valueUpperError()
    Getter for value upper error.
    Returns:
    string | number | undefined - Returns value lower error.
    Try it:
    valueUpperError(valueUpperError)
    Setter for value upper error.
    Params:
    NameTypeDefaultDescription
    valueUpperErrorstring | number
    null
    		 Value upper error to set.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    xError
    xError()
    Getter for X error.
    Returns:
    string | number - Returns X error.
    Try it:
    xError(xError)
    Setter for X error.
    Params:
    NameTypeDefaultDescription
    xErrorstring | number
    null
    		 X Error to set.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    xErrorStroke
    xErrorStroke()
    Getter for X error stroke settings.
    Returns:
    anychart.graphics.vector.Stroke - Stroke settings.
    Try it:
    xErrorStroke(strokeFunction)
    Setter for the X error stroke using a function.
    Params:
    NameTypeDefaultDescription
    strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
    function() {
 return anychart.color.darken(this.sourceColor);
}
    		 Function that looks like: 
    function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
}
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    xErrorStroke(color, thickness, dashpattern, lineJoin, lineCap)
    Setter for X error stroke settings.
Learn more about stroke settings.
    Params:
    NameTypeDescription
    coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke color.
    thicknessnumberLine thickness.
    dashpatternstringControls the pattern of dashes and gaps used to stroke paths.
    lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine joint style.
    lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    xErrorWidth
    xErrorWidth()
    Getter for X error width settings.
    Returns:
    number - Returns X error width.
    Try it:
    xErrorWidth(width)
    Setter for X error width settings. Length pins for X axis in pixels.
    Params:
    NameTypeDefaultDescription
    widthnumber
    10
    		 X error width.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    xLowerError
    xLowerError()
    Getter for X lower error.
    Returns:
    string | number | undefined - Returns X lower error.
    Try it:
    xLowerError(xLowerError)
    Setter for X lower error.
    Params:
    NameTypeDefaultDescription
    xLowerErrorstring | number
    null
    		 X lower error to set.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it:
    xUpperError
    xUpperError()
    Getter for X upper error.
    Returns:
    string | number | undefined - Returns X upper error.
    Try it:
    xUpperError(xUpperError)
    Setter for X upper error.
    Params:
    NameTypeDefaultDescription
    xUpperErrorstring | number
    null
    		 X upper error to set.
    Returns:
    anychart.core.utils.Error - Self instance for method chaining.
    Try it: