AnyChart
API Reference
Still have questions?
Contact support
Top

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:

NameTypeDescription
availabilitiesArray.<anychart.scales.Calendar.Availability>Array of availabilities. Next availability has more priority than previous.

Returns:

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

getWorkingSchedule

Gets the working time in passed datetime interval.

Params:

NameTypeDescription
startDatenumberStart date in UTC format.
endDatenumberEnd date in UTC format.
unitanychart.enums.Interval | stringUnit interval.
countnumberCount of units.

Returns:

Array.<anychart.scales.Calendar.ScheduleItem> - An array of schedule items.

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:

NameTypeDefaultDescription
var_offsetnumber
0
Offset in minutes.

Returns:

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

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:

NameTypeDescription
var_rangeArray.<number>Holidays. 0 - monday, ... , 6 - sunday. Day number does not depend on localization.

Returns:

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