class anychart.scales.Logarithmic Improve this Doc

Extends: anychart.scales.Linear

The Logarithmic class contains methods for configuring Logarithmic scale.
Note: To create instance use anychart.scales#log method.

Methods Overview

Specific settings
alignMaximum()	Align maximum settings.
alignMinimum()	Align minimum settings.
compareWith()	Changes zero for series.
comparisonMode()	Scale changes mode.
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 the tick by its position ratio.
inverted()	Inversion state.
logBase()	logarithmic base value.
maxTicksCount()	Maximum ticks count.
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.
stackDirection()	The stacking direction.
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 the tick position ratio by its name.
Miscellaneous
stackMode()	Getter for the stacked mode.

Methods Description

alignMaximum

alignMaximum()Since version 8.2.0

Getter for a flag if the maximum should be aligned by major ticks interval.

Returns:

boolean - Whether to enable maximum alignment by interval.

See listing

var scale = chart.yScale();
var alignMaximum = scale.alignMaximum();

alignMaximum(enabled)Since version 8.2.0

Getter for a flag if the maximum should be aligned by major ticks interval.

Detailed description

This method allows to align the maximum value on a scale by the major interval.
If set to false, the scale bounds don't align.

Params:

Name	Type	Default	Description
enabled	boolean	true	Whether to enable maximum alignment by interval.

Returns:

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

Try it:

Usage sample

alignMinimum

alignMinimum()Since version 8.2.0

Setter for a flag if the minimum should be aligned by major ticks interval.

Returns:

boolean - Whether to enable minimum alignment by interval.

See listing

var scale = chart.yScale();
var alignMinimum = scale.alignMinimum();

alignMinimum(enabled)Since version 8.2.0

Setter for a flag if the minimum should be aligned by major ticks interval.

Detailed description

This method allows to align the minimum value on a scale by the major interval.
If set to false, the scale bounds don't align.

Params:

Name	Type	Default	Description
enabled	boolean	true	Whether to enable minimum alignment by interval.

Returns:

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

Try it:

Usage sample

compareWith

compareWith()Since version 7.11.0

Getter for date the which should be used as a changes zero for series.

Returns:

anychart.enums.ScaleCompareWithMode | string | number - Data for the changes zero of the series.

Try it:

Usage sample

compareWith(mode)Since version 7.11.0

Setter for the date which should be used as a changes zero for series.

Params:

Name	Type	Default	Description
mode	anychart.enums.ScaleCompareWithMode \| string \| number \| Date	'firstVisible'	Mode to set

Returns:

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

Try it:

Usage sample

comparisonMode

comparisonMode()Since version 7.11.0

Getter for the scale changes mode.

Returns:

anychart.enums.ScaleComparisonMode | string - The scale changes mode.

Try it:

Usage sample

comparisonMode(mode)Since version 7.11.0

Setter for the scale changes mode.

Detailed description

If comparison mode has 'value' or 'percent' value, then legend point and tooltip point have next context fields: 'valueChange', 'valuePercentChange', 'valueRatioChange'.

Params:

Name	Type	Default	Description
mode	anychart.enums.ScaleComparisonMode \| string	'none'	Comparison mode to set.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Description
var_args	*	Values that are supposed to extend the input domain.

Returns:

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

Try it:

Usage sample

finishAutoCalc

finishAutoCalc(silently)

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

Params:

Name	Type	Description
silently	boolean	If 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:

Usage sample

inverseTransform

inverseTransform(ratio)

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

Params:

Name	Type	Description
ratio	number	Value to transform in input scope.

Returns:

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

Try it:

Usage sample

inverted

inverted()

Getter for the scale inversion.

Returns:

boolean - The inversion state.

inverted(enabled)

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:

Name	Type	Default	Description
enabled	boolean	false	Inverted state to set.

Returns:

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

Try it:

Usage sample

logBase

logBase()

Getter for the logarithmic base value.

Returns:

number - Logarithmic base value.

logBase(baseValue)

Setter for the logarithmic base value.
Note: Affects tick values auto calculation.

Params:

Name	Type	Default	Description
baseValue	number	10	Logarithmic base value to set. Takes any number greater than 1.

Returns:

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

Try it:

Usage sample

maxTicksCount

maxTicksCount()Since version 7.13.0

Getter for the maximum ticks count.

Returns:

number - Maximum ticks count.

See listing

var maxTicksCount = scale.maxTicksCount();

maxTicksCount(count)Since version 7.13.0

Setter for the maximum ticks count.

Detailed description

Use this method only if you set the ticks with the anychart.scales.ScatterTicks#interval method. It is ignored if the number of ticks is set manually via the method anychart.scales.ScatterTicks#count.
The method does not summarize both major and minor ticks, considering each separately, but the whole range from minimum to maximum.
If the number of ticks is greater than the passed value, the auto-calculation drops the interval from 4 to 6 ticks.

Params:

Name	Type	Default	Description
count	number	1000	Maximum ticks count to set.

Returns:

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

Try it:

Usage sample

maximum

maximum()

Getter for the scale maximum.

Returns:

number - Scale maximum.

See listing

var scale = chart.yScale();
var maximum = scale.maximum();

maximum(maximum)

Setter for the scale maximum.

Params:

Name	Type	Default	Description
maximum	number	null	Maximum value to set.

Returns:

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

Try it:

Usage sample

maximumGap

maximumGap()

Getter for the scale maximum gap.

Returns:

number - Scale maximum gap.

maximumGap(gap)

Setter for the scale maximum gap.

Detailed description

Note: Gap works only if scale maximum is not set explicitly using anychart.scales.ScatterBase#maximum.

Params:

Name	Type	Default	Description
gap	number	0.1	Gap value from 0 to 1.

Returns:

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

Try it:

Usage sample

minimum

minimum()

Getter for the scale minimum.

Returns:

number - Scale minimum.

See listing

var scale = chart.yScale();
var minimum = scale.minimum();

minimum(minimum)

Setter for the scale minimum.

Params:

Name	Type	Default	Description
minimum	number	null	Scale minimum to set.

Returns:

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

Try it:

Usage sample

minimumGap

minimumGap()

Getter for the scale minimum gap.

Returns:

number - Scale minimum gap.

minimumGap(gap)

Setter for the scale minimum gap.

Detailed description

Note: Gap works only if scale minimum is not set explicitly using anychart.scales.ScatterBase#minimum.

Params:

Name	Type	Default	Description
gap	number	0.1	Gap value from 0 to 1.

Returns:

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

Try it:

Usage sample

minorTicks

minorTicks()

Getter for set of scale minor ticks in terms of data values.

Returns:

anychart.scales.ScatterTicks - Minor ticks.

Try it:

Usage sample

minorTicks(settings)

Setter for set of scale minor ticks in terms of data values.

Params:

Name	Type	Description
settings	Object \| Array	An array or object of ticks to set.

Returns:

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

Try it:

Usage sample

softMaximum

softMaximum()Since version 7.6.0

Getter for the soft maximum.

Returns:

number - Soft maximum value.

Try it:

Usage sample

softMaximum(maximum)Since version 7.6.0

Setter for the soft maximum.

Detailed description

If data range maximum is less than the soft maximum, the soft maximum value becomes the scale maximum.

Params:

Name	Type	Default	Description
maximum	number	null	Soft maximum to set

Returns:

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

Try it:

Usage sample

softMinimum

softMinimum()Since version 7.6.0

Getter for the soft minimum.

Returns:

number - Soft minimum value.

Try it:

Usage sample

softMinimum(minimum)Since version 7.6.0

Setter for the soft minimum.

Detailed description

If data range minimum is greater than the soft minimum, the soft minimum value becomes the scale minimum.

Params:

Name	Type	Default	Description
minimum	number	null	Soft minimum value to set

Returns:

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

Try it:

Usage sample

stackDirection

stackDirection()Since version 8.0.0

Getter for the stacking direction.

Returns:

anychart.enums.ScaleStackDirection | string - The stacking direction.

See listing

var stackDirection = scale.stackDirection();

stackDirection(direction)Since version 8.0.0

Setter for the stacking direction.

Detailed description

This method works only if anychart.scales.Linear#stackMode method has not "none" value.

Params:

Name	Type	Default	Description
direction	anychart.enums.ScaleStackDirection \| string	'direct'	The stacking direction.

Returns:

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

Try it:

Usage sample

stackMode

stackMode()

Getter for the stacked mode.

Returns:

anychart.enums.ScaleStackMode - Stack mode.

Try it:

Usage sample

stackMode(value)

Setter for the stacked mode.

Params:

Name	Type	Default	Description
value	anychart.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 - Self instance for method chaining.

stickToZero

stickToZero()

Getter for stick to zero.

Returns:

boolean - State stick to zero.

Try it:

Usage sample

stickToZero(enabled)

Setter for stick to zero. Flag to stick to zero value on auto calc if gaps lead to zero crossing.

Params:

Name	Type	Default	Description
enabled	boolean	true	Whether to stick to zero.

Returns:

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

Try it:

Usage sample

ticks

ticks()

Getter for set of scale ticks in terms of data values.

Returns:

anychart.scales.ScatterTicks - Ticks.

Try it:

Usage sample

ticks(settings)

Setter for set of scale ticks in terms of data values.

Params:

Name	Type	Description
settings	Object \| Array	An array or object of ticks to set.

Returns:

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

Try it:

Usage sample

transform

transform(value)

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

Params:

Name	Type	Description
value	*	Value to transform in input scope.

Returns:

number - Value transformed to scope [0, 1].

Try it:

Usage sample