class anychart.scales.DateTimeWithCalendar Improve this Doc

Date scale with calendar support.

Methods Overview

Specific settings
calendar()	Calendar settings.
count()	Count settings.
dateToPix()	Transforms date to pixels.
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.
getTicks()	Returns ticks array.
getType()	Returns scale type.
inverseTransform()	Returns tick by its position ratio.
inverted()	Inversion state.
maximum()	Scale maximum.
maximumGap()	Maximum gap settings.
minimum()	Scale minimum.
minimumGap()	Minimum gap settings.
pixToDate()	Transforms pixels to date.
skipHolidays()	Holidays 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
startDate()	Start date.
transform()	Returns tick position ratio by its name.
unit()	Unit settings.
unitPixSize()	Unit size settings.
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.

Methods Description

calendar

calendar()Since version 7.12.0

Getter for the scale calendar.

Returns:

anychart.scales.Calendar - Calendar instance.

Try it:

Usage sample

count

count()Since version 7.12.0

Getter for the unit count.

Returns:

number - Count.

See listing

var currentCount = scale.count();

count(value)Since version 7.12.0

Setter for the unit count.

Params:

Name	Type	Default	Description
value	number	1	Value to set.

Returns:

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

Try it:

Usage sample

dateToPix

dateToPix(date)Since version 7.12.0

Transforms date to pixels.

Params:

Name	Type	Description
date	number \| Date	Value to transform.

Returns:

number - Pixel value.

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.DateTimeWithCalendar - 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.

getTicks

getTicks(fromPix, toPix, unit, count)

Returns ticks array (even indexes are left borders, odd indexes are right borders of the tick) with passed interval. Ticks fill space from the fromPix pixel to the toPix pixel (if available).

Params:

Name	Type	Description
fromPix	number	"From" pixel.
toPix	number	"To" pixel.
unit	anychart.enums.Interval \| string	Unit interval.
count	number	Unit count.

Returns:

Array.<anychart.scales.DateTimeWithCalendar.Tick> - Returns ticks array.

Try it:

Usage sample

getType

getType()

Returns scale type.

Returns:

string - Scale type.

Try it:

Usage sample

inverseTransform

inverseTransform(ratio)

Returns 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.

Try it:

Usage sample

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:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

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

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		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 }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

maximum

maximum()

Getter for the current scale maximum.

Returns:

number - Current scale maximum.

maximum(value)

Setter for scale maximum.

Params:

Name	Type	Default	Description
value	number	null	Value to set.

Returns:

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

Try it:

Usage sample

maximumGap

maximumGap()Since version 7.12.0

Getter for the current scale maximum gap.

Returns:

number - The current scale maximum gap.

See listing

var scale = chart.xScale();
var currentMaximumGap = scale.maximumGap();

maximumGap(value)Since version 7.12.0

Setter for the scale maximum gap.

Detailed description

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

Params:

Name	Type	Default	Description
value	number	0.01	Value from 0 to 1.

Returns:

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

Try it:

Usage sample

minimum

minimum()

Getter for the current scale minimum.

Returns:

number - Current scale minimum.

minimum(value)

Setter for scale minimum.

Params:

Name	Type	Default	Description
value	number	null	Value to set.

Returns:

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

Try it:

Usage sample

minimumGap

minimumGap()Since version 7.12.0

Getter for the scale minimum gap.

Returns:

number - The current scale minimum gap.

See listing

var scale = chart.xScale();
var currentMinimumGap = scale.minimumGap();

minimumGap(value)Since version 7.12.0

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
value	number	0.01	Value from 0 to 1.

Returns:

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

Try it:

Usage sample

pixToDate

pixToDate(pix)Since version 7.12.0

Transforms pixels to date.

Params:

Name	Type	Description
pix	number	Value to transform.

Returns:

number - Date value.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

skipHolidays

skipHolidays()Since version 7.12.0

Getter for skipping holidays.

Returns:

boolean - State flag.

See listing

var flag = scale.skipHolidays();

skipHolidays(value)Since version 7.12.0

Setter for skipping holidays.

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

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

Try it:

Usage sample

softMaximum

softMaximum()Since version 7.12.0

Getter for the soft maximum.

Returns:

number - Soft maximum.

See listing

var scale = chart.xScale();
var maximum = scale.softMaximum();

softMaximum(value)Since version 7.12.0

Setter for the soft maximum.

Detailed description

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

Params:

Name	Type	Description
value	number	Value to set

Returns:

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

Try it:

Usage sample

softMinimum

softMinimum()Since version 7.12.0

Getter for the soft minimum.

Returns:

number - Soft minimum.

See listing

var scale = chart.xScale();
var minimum = scale.softMinimum();

softMinimum(value)Since version 7.12.0

Setter for the soft minimum.

Detailed description

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

Params:

Name	Type	Description
value	number	Value to set

Returns:

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

Try it:

Usage sample

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.DateTimeWithCalendar - Chaining.

startDate

startDate()Since version 7.12.0

Getter for the start date.

Returns:

number - Start date.

Try it:

Usage sample

transform

transform(value)

Returns 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

unit

unit()Since version 7.12.0

Getter for the unit interval.

Returns:

anychart.enums.Interval - Unit interval.

See listing

var currentUnit = scale.unit();

unit(value)Since version 7.12.0

Setter for the unit interval.

Params:

Name	Type	Default	Description
value	anychart.enums.Interval \| string	"day"	Value to set.

Returns:

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

Try it:

Usage sample

unitPixSize

unitPixSize()Since version 7.12.0

Getter for the unit size.

Returns:

number | string - Unit size.

See listing

var size = scale.unitPixSize();

unitPixSize(value)Since version 7.12.0

Setter for unit size.

Params:

Name	Type	Default	Description
value	number \| string	100	Value to set.

Returns:

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

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name	Type	Description
key	Object	The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample