class anychart.scales.Calendar Improve this Doc
Extends: anychart.core.Base
Calendar scale. Note: To create instance use anychart.scales#calendar method.
Methods Overview
| 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. |
| Special | |
| getWorkingSchedule() | Gets the working time in passed datetime interval. |
| Special settings | |
| availabilities() | Availabilities settings. |
| timezoneOffset() | Timezone offset settings. |
| weekendRange() | Settings for regular weekend days. |
Methods Description
availabilities
Getter for the availabilities for the calendar.
Returns:
Array.<anychart.scales.Calendar.Availability> - The current availabilities. See listing
var currentCalendar = chart.calendar(); var availabilities = currentCalendar.availabilities();
Setter for the availabilities for the calendar.
Params:
| Name | Type | Description |
|---|---|---|
| value | Array.<anychart.scales.Calendar.Availability> | Array of availabilities. Next availability has more priority than previous. |
Returns:
anychart.scales.Calendar - Self instance for method chaining.Try it:
getWorkingSchedule
Gets the working time in passed datetime interval.
Detailed description
Returns intervals of working days between two passed dates. The result is an array of whole day schedules for each
day in the passed range. Schedule for each day is represented as an array of tuples [startTime, endTime] each tuple
represents an interval of working time. The end of the day is considered at 23:59. All timestamps are shifted
according to the anychart.scales.Calendar#timezoneOffset of the calendar (so the day is considered starting at -offset hours UTC and last for
exactly 24 hours).
Params:
| Name | Type | Description |
|---|---|---|
| startDate | number | Start date in UTC format. |
| endDate | number | End date in UTC format. |
| unit | anychart.enums.Interval | string | Unit interval. |
| count | number | Count of units. |
Returns:
Array.<anychart.scales.Calendar.ScheduleItem> - An array of schedule items.Try it:
listen
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.
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:
listenOnce
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).
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:
removeAllListeners
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:
timezoneOffset
Getter for the timezone offset.
Returns:
Array.<number> - The current timezone offset in minutes. See listing
var currentCalendar = chart.calendar(); var offset = currentCalendar.timezoneOffset();
Setter for the timezone offset for the output availabilities.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| var_value | number | 0 | Offset in minutes. |
Returns:
anychart.scales.Calendar - Self instance for method chaining.Try it:
unlisten
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:
unlistenByKey
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:
weekendRange
Getter for the regular weekend days.
Returns:
Array.<number> - The current weekend days. See listing
var currentCalendar = chart.calendar(); var range = currentCalendar.weekendRange();
Setter for the regular weekend days.
Params:
| Name | Type | Description |
|---|---|---|
| var_value | Array.<number> | Holidays. 0 - monday, ... , 6 - sunday. Day number does not depend on localization. |
Returns:
anychart.scales.Calendar - Self instance for method chaining.Try it: