AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.scales.DateTimeWithCalendar Improve this Doc

Extends: anychart.scales.ScatterBase

The DateTimeWithCalendar class contains methods for configuring calendar on the DateTime scale.

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.
maxTicksCount()Maximum ticks count.
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

Getter for the scale calendar.

Returns:

anychart.scales.Calendar - Calendar instance.

count

Getter for the unit count.

Returns:

number - Unit count.
See listing
var count = scale.count();
Setter for the unit count.

Params:

NameTypeDefaultDescription
countnumber
1
Unit count to set.

Returns:

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

dateToPix

Transforms date to pixels.

Params:

NameTypeDescription
datenumber | DateValue to transform.

Returns:

number - Pixel value.

extendDataRange

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.DateTimeWithCalendar - Self instance for method chaining.

finishAutoCalc

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.

getTicks

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

Params:

NameTypeDescription
fromPixnumber"From" pixel.
toPixnumber"To" pixel.
unitanychart.enums.Interval | stringUnit interval.
countnumberUnit count.

Returns:

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

getType

Returns scale type.

Returns:

string - Scale type.

inverseTransform

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.

inverted

Getter for the scale inversion.

Returns:

boolean - The inversion state.
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
enabledboolean
false
Inverted state to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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.

maxTicksCount

Getter for the maximum ticks count.

Returns:

number - Maximum ticks count.
See listing
var maxTicksCount = scale.maxTicksCount();
Setter for the maximum ticks count.

Params:

NameTypeDefaultDescription
countnumber
1000
Maximum ticks count to set.

Returns:

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

maximum

Getter for the scale maximum.

Returns:

number - Scale maximum.
See listing
var scale = chart.yScale();
var maximum = scale.maximum();
Setter for the scale maximum.

Params:

NameTypeDefaultDescription
maximumnumber
null
Maximum value to set.

Returns:

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

maximumGap

Getter for the scale maximum gap.

Returns:

number - The scale maximum gap.
See listing
var scale = chart.xScale();
var maximumGap = scale.maximumGap();
Setter for the scale maximum gap.

Params:

NameTypeDefaultDescription
gapnumber
0.01
Gap value from 0 to 1.

Returns:

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

minimum

Getter for the scale minimum.

Returns:

number - Scale minimum.
See listing
var scale = chart.yScale();
var minimum = scale.minimum();
Setter for the scale minimum.

Params:

NameTypeDefaultDescription
minimumnumber
null
Scale minimum to set.

Returns:

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

minimumGap

Getter for the scale minimum gap.

Returns:

number - The scale minimum gap.
See listing
var scale = chart.xScale();
var minimumGap = scale.minimumGap();
Setter for the scale minimum gap.

Params:

NameTypeDefaultDescription
gapnumber
0.01
Gap value from 0 to 1.

Returns:

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

pixToDate

Transforms pixels to date.

Params:

NameTypeDescription
pixnumberValue to transform.

Returns:

number - Date value.

removeAllListeners

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.

skipHolidays

Getter for skipping of holidays.

Returns:

boolean - State flag.
See listing
var flag = scale.skipHolidays();
Setter for skipping of holidays.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to skip holidays.

Returns:

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

softMaximum

Getter for the soft maximum.

Returns:

number - Soft maximum.
See listing
var scale = chart.xScale();
var maximum = scale.softMaximum();
Setter for the soft maximum.

Params:

NameTypeDescription
maximumnumberSoft maximum value to set

Returns:

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

softMinimum

Getter for the soft minimum.

Returns:

number - Soft minimum.
See listing
var scale = chart.xScale();
var minimum = scale.softMinimum();
Setter for the soft minimum.

Params:

NameTypeDescription
minimumnumberSoft minimum value to set

Returns:

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

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 - Self instance for method chaining.

startDate

Getter for the start date.

Returns:

number - Start date.

transform

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

unit

Getter for the unit interval.

Returns:

anychart.enums.Interval - Unit interval.
See listing
var unit = scale.unit();
Setter for the unit interval.

Params:

NameTypeDefaultDescription
intervalanychart.enums.Interval | string
'day'
Unit interval to set.

Returns:

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

unitPixSize

Getter for the unit size.

Returns:

number | string - Unit size.
See listing
var size = scale.unitPixSize();
Setter for the unit size.

Params:

NameTypeDefaultDescription
sizenumber | string
100
Unit size to set.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
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.

unlistenByKey

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.