class anychart.scales.Calendar Improve this Doc
Extends: anychart.core.Base
The Calendar class contains methods for configuring calendar in the Resource chart. Note: To create instance use anychart.scales#calendar method.
Methods Overview
| 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> - An array of the availabilities. See listing
var calendar = chart.calendar(); var availabilities = calendar.availabilities();
Setter for the availabilities for the calendar.
Params:
| Name | Type | Description |
|---|---|---|
| availabilities | 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:
timezoneOffset
Getter for the timezone offset.
Returns:
Array.<number> - An array of the timezone offset in minutes. See listing
var calendar = chart.calendar(); var timezoneOffset = calendar.timezoneOffset();
Setter for the timezone offset for the output availabilities.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| var_offset | number | 0 | Offset in minutes. |
Returns:
anychart.scales.Calendar - Self instance for method chaining.Try it:
weekendRange
Getter for the regular weekend days.
Returns:
Array.<number> - An array of the regular weekend days. See listing
var calendar = chart.calendar(); var weekendRange = calendar.weekendRange();
Setter for the regular weekend days.
Params:
| Name | Type | Description |
|---|---|---|
| var_range | 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: