class anychart.core.calendar.settings.Days Improve this Doc
Extends: anychart.core.Base
Days settings.
Methods Overview
| Coloring | |
| fill() | Fill settings. |
| hatchFill() | Hatch fill settings. |
| noDataFill() | Fill settings. |
| noDataHatchFill() | Hatch fill settings. |
| noDataStroke() | Stroke settings. |
| stroke() | Stroke settings. |
| Interactivity | |
| hovered() | Day cells hovered state settings. |
| normal() | Day cells normal state settings. |
| Size and Position | |
| spacing() | Days cells space. |
Methods Description
fill
Gets the fill value for days cells that represents data.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - Fill color.Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an array, an object or a string. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for fill settings using function.
Params:
| Name | Type | Description |
|---|---|---|
| fillFunction | function():anychart.graphics.vector.Fill | Function that looks like: function(){
// Context:
// this.value - value from data for current day cell.
// this.sourceColor - blue 0.5.
// Additional fields if colorScale () is set:
// this.scaledColor - color from this.colorScale for this value.
return fillValue; // Type is anychart.graphics.vector.Fill
} |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Fill color with opacity.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.hatchFill
Gets the hatch fill value for days cells that represents data.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.Setter for hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | anychart.graphics.vector.HatchFill.HatchFillType | string | false | Type of hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill settings using function.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill settings using pattern fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill settings using an instance.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill using boolean.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.hovered
Getter for hovered state settings for plot day cells.
Returns:
anychart.core.StateSettings - Hovered state settings.Setter for hovered state settings for plot day cells.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.noDataFill
Gets the fill value for days cells that doesn't represent data.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - The fill color.Setter for settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Fill color with opacity.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.noDataHatchFill
Gets the hatch fill value for days cells that doesn't represent data.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.Setter for hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | anychart.graphics.vector.HatchFill.HatchFillType | string | false | Type of hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill settings using function.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill settings using pattern fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill settings using an instance.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for hatch fill using boolean.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.noDataStroke
Gets the stroke value for days cells that doesn't represent data.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Setter for stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for stroke settings using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with stroke settings from anychart.graphics.vector.Stroke |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.normal
Getter for normal state settings for plot day cells.
Returns:
anychart.core.StateSettings - Normal state settings.Setter for normal state settings for plot day cells.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.spacing
Gets the value of the space between day cells for each four sides.
Returns:
number - Space between day cells.Sets the space between day cells for each four sides.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | Value for spacing to set. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.stroke
Gets the stroke value for days cells that represents data.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Setter for the days stroke by function.
Params:
| Name | Type | Description |
|---|---|---|
| strokeFunction | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill | Function that looks like: function(){
// this.sourceColor - blue 0.5.
// this.scaledColor - color returned by color scale for this value.
// this.value - value from data for current day cell.
return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
} |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.Setter for stroke settings using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with stroke settings from anychart.graphics.vector.Stroke |
Returns:
anychart.core.calendar.settings.Days - Self instance for method chaining.