AnyChart
API Reference
Still have questions?
Contact support
    Top
    You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

    class anychart.scales.Logarithmic Improve this Doc

    Extends: anychart.scales.Linear

    Define Logarithmic scale.
    Note: To create instance use anychart.scales#log method.

    Methods Overview

    Specific settings
    extendDataRange()Extends the current input domain with the passed values (if such don't exist in the domain).
    finishAutoCalc()Informs the scale that an auto range calculation started for the chart in past was ended.
    getType()Returns scale type.
    inverseTransform()Returns tick by its position ratio.
    inverted()Inversion state.
    logBase()Log base value.
    maximum()Scale maximum.
    maximumGap()Maximum gap settings.
    minimum()Scale minimum.
    minimumGap()Minimum gap settings.
    minorTicks()Minor ticks settings.
    softMaximum()Soft maximum settings.
    softMinimum()Soft minimum settings.
    startAutoCalc()Informs scale that an auto range calculation started for the chart, so it should reset its data range on the first
    stickToZero()Stick to zero.
    ticks()Ticks settings.
    transform()Returns tick position ratio by its name.
    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.
    Miscellaneous
    stackMode()Getter for stacked mode.

    Methods Description

    extendDataRange

    extendDataRange(var_args)

    Extends the current input domain with the passed values (if such don't exist in the domain).
    Note: Attention! anychart.scales.Base#finishAutoCalc drops all passed values.

    Params:

    NameTypeDescription
    var_args*Values that are supposed to extend the input domain.

    Returns:

    anychart.scales.Logarithmic - Self instance for method chaining.

    Try it:

    finishAutoCalc

    finishAutoCalc(silently)

    Informs the scale that an auto range calculation started for the chart in past was ended.

    Params:

    NameTypeDescription
    silentlybooleanIf this flag is set, do not dispatch an event if reapplication needed.

    Returns:

    boolean - If the calculation changed the scale and it needs to be reapplied.

    getType

    getType()

    Returns scale type.

    Returns:

    string - Scale type.

    Try it:

    inverseTransform

    inverseTransform(ratio)

    Returns tick by its position ratio. Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().

    Params:

    NameTypeDescription
    rationumberValue to transform in input scope.

    Returns:

    * - Value transformed to output scope [0, 1].

    Try it:

    inverted

    inverted()

    Getter for scale inversion.

    Returns:

    boolean - Current inversion state.

    inverted(value)

    Setter for scale inversion. If the scale is inverted, axes and series go upside-down or right-to-left instead of bottom-to-top and left-to-right.

    Params:

    NameTypeDefaultDescription
    valueboolean
    false
    		 Value to set.

    Returns:

    anychart.scales.Logarithmic - Self instance for method chaining.

    Try it:

    listen

    listen(type, listener, useCapture, listenerScope)

    Adds an event listener to an implementing object.

    Params:

    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		Callback method. Function that looks like function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}.
    useCaptureboolean
    false
    		 Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
    listenerScopeObject
    		Object in whose scope to call the listener.
    Returns:
    Object - Unique key for the listener.
    Try it:
    listenOnce
    listenOnce(type, listener, useCapture, listenerScope)
    Adds an event listener to an implementing object.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		Callback method.
    useCaptureboolean
    false
    		 Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
    listenerScopeObject
    		Object in whose scope to call the listener.
    Returns:
    Object - Unique key for the listener.
    Try it:
    logBase
    logBase()
    Getter for Log base value.
    Returns:
    number - Current Log base.
    logBase(value)
    Setter for Log base value.
    
Note: Affects tick values auto calculation.
    Params:
    NameTypeDefaultDescription
    valuenumber
    10
    		 Log base to set. Takes any number greater than 1.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    maximum
    maximum()
    Getter for the current scale maximum.
    Returns:
    number - Current scale maximum.
    maximum(value)
    Setter for scale maximum.
    Params:
    NameTypeDefaultDescription
    valuenumber
    null
    		 Value to set.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    maximumGap
    maximumGap()Since version 7.6.0
    Getter for the current scale maximum gap.
    Returns:
    number - The current scale maximum gap.
    Try it:
    maximumGap(value)Since version 7.6.0
    Setter for the scale maximum gap.
    Params:
    NameTypeDefaultDescription
    valuenumber
    0.1
    		 Value from 0 to 1.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    minimum
    minimum()
    Getter for the current scale minimum.
    Returns:
    number - Current scale minimum.
    minimum(value)
    Setter for scale minimum.
    Params:
    NameTypeDefaultDescription
    valuenumber
    null
    		 Value to set.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    minimumGap
    minimumGap()Since version 7.6.0
    Getter for the current scale minimum gap.
    Returns:
    number - The current scale minimum gap.
    Try it:
    minimumGap(value)Since version 7.6.0
    Setter for the scale minimum gap.
    Params:
    NameTypeDefaultDescription
    valuenumber
    0.1
    		 Value from 0 to 1.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    minorTicks
    minorTicks()
    Getter for set of scale minor ticks in terms of data values.
    Returns:
    anychart.scales.ScatterTicks - Current ticks.
    Try it:
    minorTicks(value)
    Setter for set of scale minor ticks in terms of data values.
    Params:
    NameTypeDescription
    valueObject | ArrayAn array of ticks to set.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    removeAllListeners
    removeAllListeners(type)
    Removes all listeners from an object. You can also optionally remove listeners of some particular type.
    Params:
    NameTypeDescription
    typestringType of event to remove, default is to remove all types.
    Returns:
    number - Number of listeners removed.
    Try it:
    softMaximum
    softMaximum()Since version 7.6.0
    Getter for the current soft maximum.
    Returns:
    number - Current soft maximum.
    Try it:
    softMaximum(value)Since version 7.6.0
    Setter for soft maximum.
    Params:
    NameTypeDefaultDescription
    valuenumber
    null
    		 Value to set
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    softMinimum
    softMinimum()Since version 7.6.0
    Getter for the current soft minimum.
    Returns:
    number - Current soft minimum.
    Try it:
    softMinimum(value)Since version 7.6.0
    Setter for soft minimum.
    Params:
    NameTypeDefaultDescription
    valuenumber
    null
    		 Value to set
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    stackMode
    stackMode()
    Getter for stacked mode.
    Returns:
    anychart.enums.ScaleStackMode - Current stack mode.
    Try it:
    stackMode(value)
    Setter for stacked mode.
    Params:
    NameTypeDefaultDescription
    valueanychart.enums.ScaleStackMode | string
    "none"
    		 Value to set.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    startAutoCalc
    startAutoCalc()
    Informs scale that an auto range calculation started for the chart, so it should reset its data range on the first
call of this method if needed.
    Returns:
    anychart.scales.Logarithmic - Chaining.
    stickToZero
    stickToZero()
    Getter for stick to zero.
    Returns:
    boolean - Current state stick to zero.
    Try it:
    stickToZero(value)
    Setter for stick to zero.
Flag to stick to zero value on auto calc if gaps lead to zero crossing.
    Params:
    NameTypeDefaultDescription
    valueboolean
    true
    		 Value to set.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    ticks
    ticks()
    Getter for set of scale ticks in terms of data values.
    Returns:
    anychart.scales.ScatterTicks - Current ticks.
    Try it:
    ticks(value)
    Setter for set of scale ticks in terms of data values.
    Params:
    NameTypeDescription
    valueObject | ArrayAn array of ticks to set.
    Returns:
    anychart.scales.Logarithmic - Self instance for method chaining.
    Try it:
    transform
    transform(value)
    Returns tick position ratio by its name.
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().
    Params:
    NameTypeDescription
    value*Value to transform in input scope.
    Returns:
    number - Value transformed to scope [0, 1].
    Try it:
    unlisten
    unlisten(type, listener, useCapture, listenerScope)
    Removes a listener added using listen() or listenOnce() methods.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		Callback method.
    useCaptureboolean
    false
    		 Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
    listenerScopeObject
    		Object in whose scope to call the listener.
    Returns:
    boolean - Whether any listener was removed.
    Try it:
    unlistenByKey
    unlistenByKey(key)
    Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
    Params:
    NameTypeDescription
    keyObjectThe key returned by listen() or listenOnce().
    Returns:
    boolean - Whether any listener was removed.
    Try it:
    AnyChart - JavaSript charts is a trusted solution for data visualization