AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.calendar.settings.Weeks Improve this Doc

Extends: anychart.core.Base

Weeks settings.

Methods Overview

Specific settings
showWeekends()Show weekend labels and corresponding day cells.
Labels
labels()Weeks labels settings.
Size and Position
rightSpace()Space between labels and plot.

Methods Description

labels

Getter for weeks labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for weeks labels.

Params:

NameTypeDescription
settingsObject | boolean | nullLabels settings.

Returns:

anychart.core.calendar.settings.Weeks - Self instance for method chaining.

rightSpace

Gets the value of a space between week labels and a calendar plot.

Returns:

number - Space between labels and plot.
Sets the value of a margin between week labels and a calendar plot.

Params:

NameTypeDescription
valuenumberValue to set in pixels.

Returns:

anychart.core.calendar.settings.Weeks - Self instance for method chaining.

showWeekends

Gets the value that defines should we display weekend labels and corresponding day cells. Weekends can be set throughout locale.

Returns:

boolean - Whether to show or not.
Sets the value that defines should we display weekend labels and corresponding day cells.

Params:

NameTypeDescription
valuebooleanShow labels and day cells.

Returns:

anychart.core.calendar.settings.Weeks - Self instance for method chaining.