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. |
Events | |
listen() | Adds an event listener. |
listenOnce() | Adds a single time event listener. |
removeAllListeners() | Removes all listeners. |
unlisten() | Removes the listener. |
unlistenByKey() | Removes the listener by the key. |
Export | |
print() | Prints all elements. |
Interactivity | |
enabled() | Element state (enabled or disabled). |
Size and Position | |
bottom() | Bottom bound setting. |
bounds() | Bounds settings. |
getPixelBounds() | Returns pixel bounds. |
height() | Height setting. |
left() | Left bound setting. |
maxHeight() | Maximum height. |
maxWidth() | Maximum width. |
minHeight() | Minimum height. |
minWidth() | Minimum width. |
right() | Right bound setting. |
top() | Top bound setting. |
width() | Width setting. |
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 |
---|---|---|
value | string | Object | null | boolean | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.bottom
Returns:
number | string | undefined - Current element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Params:
Name | Type | Description |
---|---|---|
value | 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 currentGrid = chart.grid(); var flag = currentGrid.drawBottomLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawLeftLine
Returns:
boolean - Drawing flag.var currentGrid = chart.grid(); var flag = currentGrid.drawLeftLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawRightLine
Returns:
boolean - Drawing flag.var currentGrid = chart.grid(); var flag = currentGrid.drawRightLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
drawTopLine
Returns:
boolean - Drawing flag.var currentGrid = chart.grid(); var flag = currentGrid.drawTopLine();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
enabled
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value 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 currentGrid = chart.grid(); var evenFillSettings = currentGrid.evenFill();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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:
evenHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The even hatch fill.var currentActivities = chart.activities(); var currentHatchFill = currentActivities.evenHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | false | PatternFill or HatchFill instance or 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:
evenHolidayFill
Returns:
anychart.graphics.vector.Fill - The even fill color.var currentGrid = chart.grid(); var evenHolidayFillSettings = currentGrid.evenHolidayFill();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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 currentActivities = chart.activities(); var currentHatchFill = currentActivities.evenHolidayHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | false | PatternFill or HatchFill instance or 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:
getPixelBounds
Returns:
anychart.math.Rect - Pixel bounds of the element.height
Returns:
number | string | undefined - Current element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Height setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
horizontalStroke
Returns:
anychart.graphics.vector.Stroke | function - The horizontal stroke.var currentGrid = chart.grid(); var strokeSettings = currentGrid.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 | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
left
Returns:
number | string | undefined - Current element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
listen
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
} . | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
maxHeight
Returns:
number | string | null - Current element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Current element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Current element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Current element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value 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 currentGrid = chart.grid(); var oddFillSettings = currentGrid.oddFill();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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 currentActivities = chart.activities(); var currentHatchFill = currentActivities.oddHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | false | PatternFill or HatchFill instance or 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:
oddHolidayFill
Returns:
anychart.graphics.vector.Fill - The odd fill color.var currentGrid = chart.grid(); var oddHolidayFillSettings = currentGrid.oddHolidayFill();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
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 currentActivities = chart.activities(); var currentHatchFill = currentActivities.oddHolidayHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | false | PatternFill or HatchFill instance or 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:
overlay
Returns:
anychart.core.ui.Overlay - Overlay element.var element = grid.overlay();
Params:
Name | Type | Description |
---|---|---|
value | Object | null | boolean | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
landscape | boolean | false | Flag of landscape. |
Try it:
removeAllListeners
Params:
Name | Type | Description |
---|---|---|
type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
right
Returns:
number | string | undefined - Current element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | 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 - Current element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
unlisten
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
verticalStroke
Returns:
anychart.graphics.vector.Stroke | function - The vertical stroke.var currentGrid = chart.grid(); var strokeSettings = currentGrid.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 | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it:
width
Returns:
number | string | undefined - Current element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Width setting for the element. |
Returns:
anychart.core.resource.Grid - Returns self for method chaining.Try it:
zIndex
Returns:
number - The current zIndex.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.resource.Grid - Self instance for method chaining.Try it: