class anychart.core.axes.CircularTicks Improve this Doc
Extends: anychart.core.VisualBase
Axis ticks class.
Methods Overview
| Specific settings | |
| type() | Ticks type. |
| Coloring | |
| fill() | Fill settings. |
| hatchFill() | Hatch fill settings. |
| stroke() | Stroke settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| Size and Position | |
| length() | Ticks length. |
| position() | Ticks position. |
| zIndex() | Z-index of the element. |
Methods Description
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
fill
Getter for ticks fill color.
Returns:
anychart.graphics.vector.Fill | function - Ticks fill color.Try it:
Setter for ticks fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | '#545f69' | Color as an object, an array or a string. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Ticks 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 | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.core.axes.CircularTicks - 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 (0 to 1). |
Returns:
anychart.core.axes.CircularTicks - 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.axes.CircularTicks - 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.axes.CircularTicks - Self instance for method chaining.Try it:
hatchFill
Getter for ticks hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | boolean - Ticks hatch fill. See listing
var ticksSettings = axis.ticks(); var hatchFill = ticksSettings.hatchFill();
Setter for ticks hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | anychart.graphics.vector.HatchFill.HatchFillType | string | null | Type of hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it:
Setter for hatch fill settings using function.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it:
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.axes.CircularTicks - Self instance for method chaining.Try it:
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.axes.CircularTicks - Self instance for method chaining.Try it:
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.axes.CircularTicks - Self instance for method chaining.Try it:
length
Getter for ticks length.
Detailed description
This method can be used as getter only if the value has been previously set
Returns:
string - Ticks length.Try it:
Setter for ticks length.
Detailed description
Null returns auto calculated bar pointer radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| length | null | number | string | undefined | Value to set. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it:
position
Setter for ticks position.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.SidePosition | string | 'center' | Position to set. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it:
stroke
Getter for ticks stroke.
Returns:
anychart.graphics.vector.Stroke | function - Ticks stroke settings.Try it:
Setter for ticks stroke by function.
Params:
| Name | Type | Description |
|---|---|---|
| strokeFunction | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill | Function to set |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it:
Setter for ticks stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | 'none' | 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.axes.CircularTicks - Self instance for method chaining.Try it:
Setter for ticks stroke settings using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with stroke settings from anychart.graphics.vector.Stroke |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it:
type
Setter for ticks type.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | anychart.enums.MarkerType | string | function(path:anychart.graphics.vector.Path, x:number, y:number, radius:number) | 'line' | Value to set. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it:
zIndex
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 |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.core.axes.CircularTicks - Self instance for method chaining.Try it: