class anychart.core.calendar.settings.Years Improve this Doc
Extends: anychart.core.Base
Years settings.
Methods Overview
| Specific settings | |
| background() | Background settings |
| inverted() | Order of plots by year. |
| title() | Title settings |
| Size and Position | |
| underSpace() | Space between plots. |
Methods Description
background
Getter for the plots background settings.
Returns:
anychart.core.ui.Background - Chart background.Setter for the plots background settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | {enabled: true, fill: "#fff", stroke: 'none'} | Background object to set. |
Returns:
anychart.core.calendar.settings.Years - Self instance for method chaining.inverted
Gets the value that defines order of the plots.
In case of "true" plots are shown in descending order.
Returns:
boolean - Whether to show or not.Sets the value that defines order of the plots.
In case of "true" plots will be shown in descending order.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Show labels and day cells. |
Returns:
anychart.core.calendar.settings.Years - Self instance for method chaining.title
Getter for the plots title settings.
Returns:
anychart.core.ui.Title - Chart title.Setter for the plots title.
Detailed description
Sets chart title settings depending on parameter type:
- null/boolean - disable or enable chart title.
- string - sets chart title text value.
- object - sets chart title settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.core.calendar.settings.Years - Self instance for method chaining.underSpace
Gets the value of a space between plots.
Returns:
number - Space between plots.Sets the value of a space between plots.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | Value to set in pixels. |
Returns:
anychart.core.calendar.settings.Years - Self instance for method chaining.