class anychart.standalones.grids.Polar Improve this Doc

The Polar class contains methods for configuring standalones Polar grids.

Methods Overview

Specific settings
axis()	Axis settings.
drawLastLine()	Drawing last line.
isMinor()	Minor grid or not.
Chart Coloring
palette()	Palette settings.
Coloring
fill()	Fill settings.
stroke()	Stroke settings.
Interactivity
enabled()	Element state (enabled or disabled).
Scales
xScale()	X-scale settings.
Size and Position
innerRadius()	Inner radius for the polar grid.
isRadial()	Whether a grid has the radial layout.
layout()	Layout settings for the polar grid.
startAngle()	Start angle for the polar grids.
zIndex()	Z-index of the element.
Miscellaneous
container()	Container for the elements.
draw()	Drawing of the polar grid.
parentBounds()	Getter for the parent bounds.

Methods Description

axis

axis()Since version 7.10.0

Getter for the polar grid axis.

Returns:

anychart.core.axes.Polar | anychart.core.axes.Radial - Polar grid axis.

Try it:

Usage sample

axis(axis)Since version 7.10.0

Setter for the polar grid axis.

Params:

Name	Type	Description
axis	anychart.core.axes.Polar \| anychart.core.axes.Radial	Axis instance to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

Try it:

Usage sample

container

container()

Getter for the container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - An instance of the class for method chaining.

container(element)

Setter for the container.

Params:

Name	Type	Description
element	anychart.graphics.vector.Layer \| anychart.graphics.vector.Stage \| string \| Element	The value to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

draw

draw()

Drawing of the polar grid.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

drawLastLine

drawLastLine()

Getter for the first line drawing flag.

Returns:

boolean - Drawing flag.

Try it:

Usage sample

drawLastLine(enabled)

Setter for the first line drawing flag.

Params:

Name	Type	Default	Description
enabled	boolean	true	Whether grid should draw last line.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fill

fill()Since version 8.0.0

Getter for the grid fill settings.

Returns:

string | anychart.graphics.vector.Fill - Grid fill settings.

See listing

var fill = grid.fill();

fill(color)Since version 8.0.0

Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an array, an object or a string.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

Try it:

fill(fillFunction)Since version 8.0.0

Setter for fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	function():anychart.graphics.vector.Fill	function() { return this['palette'].itemAt(this['index']); }	Function that looks like: function(){ // this.grid - grid instance. // this.palette - grid palette. // this.index - index of the grid element. return fillValue; // type anychart.graphics.vector.Fill }

Name

Type

Default

Description

fillFunction

function():anychart.graphics.vector.Fill

function() {
 return this['palette'].itemAt(this['index']);
}

Function that looks like:

function(){
   // this.grid - grid instance.
   // this.palette - grid palette.
   // this.index - index of the grid element.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.grids.Map - Self instance for method chaining.

Try it:

Usage sample

fill(color, opacity)Since version 8.0.0

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.standalones.grids.Polar - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 8.0.0

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.standalones.grids.Polar - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 8.0.0

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.standalones.grids.Polar - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 8.0.0

Image fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

Try it:

Usage sample

innerRadius

innerRadius()Since version 7.13.1

Getter for the inner radius.

Returns:

string | number - Inner radius.

innerRadius(radius)Since version 7.13.1

Setter for the inner radius.

Params:

Name	Type	Description
radius	string \| number	Inner radius to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

isMinor

isMinor()

Getter for the minor grid state flag.

Returns:

boolean - State flag.

Try it:

Usage sample

isMinor(enabled)

Setter for the minor grid state flag.

Params:

Name	Type	Default	Description
enabled	boolean	false	Minor or not.

Returns:

anychart.standalones.grids.Polar - Is minor grid or Grid instance for method chaining.

Try it:

Usage sample

isRadial

isRadial()

Whether a grid has the radial layout.

Returns:

boolean - Returns true if the grid's layout is radial.

Try it:

Usage sample

layout

layout()

Getter for the grid layout.

Returns:

anychart.enums.Layout | string - Grid layout.

layout(value)

Setter for the grid layout.

Params:

Name	Type	Description
value	anychart.enums.Layout \| string	Grid layout.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

palette

palette()Since version 8.0.0

Getter for the colors palette.

Returns:

anychart.palettes.RangeColors | anychart.palettes.DistinctColors - Grid palette.

See listing

var grid = chart.yGrid();
var palette = grid.palette();

palette(settings)Since version 8.0.0

Setter for the grid colors palette.

Detailed description

Note: You can use predefined palettes from anychart.palettes.

Params:

Name	Type	Description
settings	anychart.palettes.RangeColors \| anychart.palettes.DistinctColors \| Object \| Array.<string>	Grid colors palette settings to set.

Returns:

anychart.core.grids.Map - Self instance for method chaining.

Try it:

parentBounds

parentBounds()

Getter for the parent bounds.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Returns:

anychart.math.Rect - The parent bounds of the element.

parentBounds(bounds)

Setter for the parent bounds using single value.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

Name	Type	Description
bounds	anychart.math.Rect \| Object \| number \| null	Bounds to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

parentBounds(left, top, width, height)

Setter for the parent bounds using several values.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

Name	Type	Description
left	number	Left space.
top	number	Top space.
width	number	Element width.
height	number	Element height.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

startAngle

startAngle()

Getter for the start angle.

Returns:

string | number - Returns the start angle value.

startAngle(angle)

Setter for the start angle.

Params:

Name	Type	Description
angle	string \| number	The start angle value to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.

stroke

stroke()

Getter for the grid stroke line.

Returns:

string | anychart.graphics.vector.Stroke - Grid stroke line settings.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for the grid stroke settings. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	'#CECECE'	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	anychart.graphics.vector.StrokeLineCap		Line cap style.