class anychart.core.grids.Radar Improve this Doc
Extends: anychart.core.VisualBase
Grid.
Methods Overview
| Specific settings | |
| axis() | Axis settings. |
| drawLastLine() | Drawing last line. |
| isMinor() | Minor grid or not. |
| Coloring | |
| evenFill() | Even fill settings. |
| oddFill() | Odd fill settings. |
| stroke() | Stroke fill 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). |
| Scales | |
| xScale() | X-scale settings. |
| yScale() | Y-scale settings. |
| Size and Position | |
| isRadial() | Whether an grid has radial layout. |
| layout() | Layout setting. |
| zIndex() | Z-index of the element. |
Methods Description
axis
Getter for the current radar grid axis.
Try it:
Setter for the radar grid axis.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.core.axes.Radar | anychart.core.axes.Radial | Value to set. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
drawLastLine
Setter for the last line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true |
Whether grid should draw last line. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
enabled
Getter for the current element state (enabled or disabled).
Returns:
boolean - The current element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true |
Value to set. |
Returns:
anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled()) element.enabled(true);
Try it:
evenFill
Getter for the current grid even fill settings.
Try it:
Sets even fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Fill | "#f5f5f5 0.3" |
Color as an array or a string. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
Fill color with opacity. Fill as a string or an object.
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 | Default | Description |
|---|---|---|---|
| color | string | "#f5f5f5" |
Color as a string. |
| opacity | number | 0.3 |
Color opacity. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
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.grids.Radar - Self instance for method chaining.Try it:
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.grids.Radar - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
isMinor
Setter for the minor grid state flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false |
Minor or not. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
isRadial
Whether an grid has radial layout.
Layout is define by anychart.core.grids.Radar#layout method.
Layout is define by anychart.core.grids.Radar#layout method.
Returns:
boolean - Returns true if the grid's layout is radial.Try it:
layout
Getter for the current grid layout.
Returns:
anychart.enums.RadialGridLayout - The current grid layout.Try it:
Setter for the grid layout.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.RadialGridLayout | string | "circuit" |
Grid layout. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
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 | 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 | Whether to fire in capture phase (defaults to false). |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
Adds an event listener to an implementing object.
Detailed description
After the event is called, its handler will be deleted.
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).
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 | Description |
|---|---|---|
| type | string | The event type id. |
| listener | function | Callback method. |
| useCapture | boolean | Whether to fire in capture phase (defaults to false). |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
oddFill
Getter for the current grid odd fill settings.
Try it:
Sets odd fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Fill | "#fff 0.3" |
Color as an array or a string. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
Fill color with opacity. Fill as a string or an object.
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 | Default | Description |
|---|---|---|---|
| color | string | "#fff" |
Color as a string. |
| opacity | number | 0.3 |
Color opacity. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
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.grids.Radar - Self instance for method chaining.Try it:
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.grids.Radar - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.grids.Radar - Self instance for method chaining.Try it:
Prints all elements on related stage.
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
Removes all listeners from an object. You can also optionally remove listeners of some particular type.
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:
stroke
Getter for the current grid stroke line.
Try it:
Setter for the grid stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | "#c1c1c1" |
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.grids.Radar - Self instance for method chaining.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Description |
|---|---|---|
| type | string | The event type id. |
| listener | function | Callback method. |
| useCapture | boolean | Whether to fire in capture phase (defaults to false). |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
Params:
| Name | Type | Description |
|---|---|---|
| key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
xScale
Getter for the current grid xScale.
Returns:
anychart.scales.Ordinal - Returns chart's scale.yScale
Getter for grid yScale.
Returns:
anychart.scales.Base - Grid yScale.zIndex
Getter for the current Z-index of the element.
Returns:
number - The current zIndex.Try it:
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 |
Value to set. |
Returns:
anychart.core.VisualBase - Self instance for method chaining.Try it: