AnyChart
API Reference
Still have questions?
Contact support
Top

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

Extends: anychart.core.Base

Months settings.

Methods Overview

Coloring
noDataStroke()Stroke settings.
stroke()Stroke settings.
Labels
labels()Months labels settings.
Size and Position
underSpace()Space between labels and plot.

Methods Description

labels

Getter for months labels.

Returns:

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

Params:

NameTypeDescription
settingsObject | boolean | nullLabels settings.

Returns:

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

noDataStroke

Gets the stroke value for months that doesn't represent data.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
Setter for stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.calendar.settings.Months - Self instance for method chaining.
Setter for stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

stroke

Gets the stroke value for months cells that represents data.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
Setter for stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.calendar.settings.Months - Self instance for method chaining.
Setter for stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

underSpace

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

Returns:

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

Params:

NameTypeDescription
valuenumberValue to set in pixels.

Returns:

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