AnyChart
API Reference
Still have questions?
Contact support
Top

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.

Returns:

anychart.graphics.vector.Fill - Fill color.
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.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:

NameTypeDescription
fillFunctionfunction():anychart.graphics.vector.FillFunction 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.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.calendar.settings.Days - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.calendar.settings.Days - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject 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.
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
false
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
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:

NameTypeDescription
hatchFillFunctionfunctionHatchFill 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:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern 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:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch 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:

NameTypeDefaultDescription
enabledboolean
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:

NameTypeDescription
settingsObjectState 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.

Returns:

anychart.graphics.vector.Fill - The fill color.
Setter for settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.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.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.calendar.settings.Days - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.calendar.settings.Days - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject 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.
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
false
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
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:

NameTypeDescription
hatchFillFunctionfunctionHatchFill 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:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern 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:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch 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:

NameTypeDefaultDescription
enabledboolean
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.

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.Days - 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.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:

NameTypeDescription
settingsObjectState 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:

NameTypeDescription
valuenumberValue 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.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
Setter for the days stroke by function.

Params:

NameTypeDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFillFunction 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:

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.Days - 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.Days - Self instance for method chaining.