class anychart.core.resource.Grid Improve this Doc
Extends: anychart.core.VisualBaseWithBounds
Resource Chart grid.
Methods Overview
Specific settings | |
drawBottomLine() | Drawing of the bottom line. |
drawLeftLine() | Drawing of the left line. |
drawRightLine() | Drawing of the right line. |
drawTopLine() | Drawing of the top line. |
overlay() | Overlay element. |
Coloring | |
background() | Background settings. |
evenFill() | Even fill settings. |
evenHatchFill() | Even hatch fill settings. |
evenHolidayFill() | Even holiday fill settings. |
evenHolidayHatchFill() | Even holiday hatch fill settings. |
horizontalStroke() | Horizontal stroke settings. |
oddFill() | Odd fill settings. |
oddHatchFill() | Odd hatch fill settings. |
oddHolidayFill() | Odd holiday fill settings. |
oddHolidayHatchFill() | Odd holiday hatch fill settings. |
verticalStroke() | Vertical stroke settings. |
Interactivity | |
enabled() | Element state (enabled or disabled). |
Size and Position | |
bottom() | Bottom bound settings. |
bounds() | Bounds settings. |
getPixelBounds() | Returns pixel bounds. |
height() | Height settings. |
left() | Left bound settings. |
maxHeight() | Maximum height. |
maxWidth() | Maximum width. |
minHeight() | Minimum height. |
minWidth() | Minimum width. |
right() | Right bound settings. |
top() | Top bound settings. |
width() | Width settings. |
zIndex() | Z-index of the element. |
Methods Description
background
- null/boolean - disable or enable background.
- object - sets background settings.
- string - sets background color.
Params:
Name | Type | Description |
---|---|---|
settings | string | Object | null | boolean | Background settings to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.bottom
Returns:
number | string | undefined - Element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Bounds of the element.Params:
Name | Type | Description |
---|---|---|
bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
x | number | string | null | X-coordinate. |
y | number | string | null | Y-coordinate. |
width | number | string | null | Width. |
height | number | string | null | Height. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawBottomLine
Returns:
boolean - Drawing flag.var grid = chart.grid(); var drawBottomLine = grid.drawBottomLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawLeftLine
Returns:
boolean - Drawing flag.var grid = chart.grid(); var drawLeftLine = grid.drawLeftLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawRightLine
Returns:
boolean - Drawing flag.var grid = chart.grid(); var drawRightLine = grid.drawRightLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawTopLine
Returns:
boolean - Drawing flag.var grid = chart.grid(); var drawTopLine = grid.drawTopLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
enabled
Returns:
boolean - Element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
evenFill
Returns:
anychart.graphics.vector.Fill - The odd fill color.var grid = chart.grid(); var evenFill = grid.evenFill();
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.resource.Grid - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
evenHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The even hatch fill.var activities = chart.activities(); var evenHatchFill = activities.evenHatchFill();
Params:
Name | Type | Description |
---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | Type of the hatch fill. |
color | string | Color. |
thickness | number | Thickness. |
size | number | Pattern size. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
evenHolidayFill
Returns:
anychart.graphics.vector.Fill - The even fill color.var grid = chart.grid(); var evenHolidayFill = grid.evenHolidayFill();
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.resource.Grid - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
evenHolidayHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The even holiday hatch fill.var activities = chart.activities(); var evenHolidayHatchFill = activities.evenHolidayHatchFill();
Params:
Name | Type | Description |
---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | Type of hatch fill. |
color | string | Color. |
thickness | number | Thickness. |
size | number | Pattern size. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
getPixelBounds
Returns:
anychart.math.Rect - Pixel bounds of the element.height
Returns:
number | string | undefined - Element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Height settings for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
horizontalStroke
Returns:
anychart.graphics.vector.Stroke | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill - The horizontal stroke.var grid = chart.grid(); var horizontalStroke = grid.horizontalStroke();
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.resource.Grid - Self instance for method chaining.Try it:
left
Returns:
number | string | undefined - Element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
maxHeight
Returns:
number | string | null - Element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Maximum height to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Maximum width to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Minimum height to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Minimum width to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
oddFill
Returns:
anychart.graphics.vector.Fill - The odd fill color.var grid = chart.grid(); var oddFill = grid.oddFill();
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.resource.Grid - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
oddHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The odd hatch fill.var activities = chart.activities(); var oddHatchFill = activities.oddHatchFill();
Params:
Name | Type | Description |
---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | Type of the hatch fill. |
color | string | Color. |
thickness | number | Thickness. |
size | number | Pattern size. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
oddHolidayFill
Returns:
anychart.graphics.vector.Fill - The odd fill color.var grid = chart.grid(); var oddHolidayFill = grid.oddHolidayFill();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
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.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
oddHolidayHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The odd holiday hatch fill.var activities = chart.activities(); var oddHolidayHatchFill = activities.oddHolidayHatchFill();
Params:
Name | Type | Description |
---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | Type of the hatch fill. |
color | string | Color. |
thickness | number | Thickness. |
size | number | Pattern size. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
overlay
Returns:
anychart.core.gantt.Overlay - Overlay element.var element = grid.overlay();
Params:
Name | Type | Description |
---|---|---|
settings | Object | null | boolean | Overlay settings to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
right
Returns:
number | string | undefined - Element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
right | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
top
Returns:
number | string | undefined - Element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
verticalStroke
Returns:
anychart.graphics.vector.Stroke | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill - The vertical stroke.var grid = chart.grid(); var verticalStroke = grid.verticalStroke();
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.resource.Grid - Self instance for method chaining.Try it:
width
Returns:
number | string | undefined - Element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Width settings for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
zIndex
Params:
Name | Type | Default | Description |
---|---|---|---|
zIndex | number | 0 | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it: