AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.standalones.grids.Polar Improve this Doc

Extends: anychart.core.grids.Polar

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.
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.
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

Getter for the polar grid axis.
Setter for the polar grid axis.

Params:

NameTypeDescription
axisanychart.core.axes.Polar | anychart.core.axes.RadialAxis instance to set.

Returns:

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

container

Getter for the container.

Returns:

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

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

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

draw

Drawing of the polar grid.

Returns:

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

drawLastLine

Getter for the first line drawing flag.

Returns:

boolean - Drawing flag.
Setter for the first line drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Whether grid should draw last line.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fill

Getter for the grid fill settings.

Returns:

string | anychart.graphics.vector.Fill - Grid fill settings.
See listing
var fill = grid.fill();
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.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.
Setter for fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction():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.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDefaultDescription
colorstring
"#fff"
Color as a string.
opacitynumber
0.3
Color opacity.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

innerRadius

Getter for the inner radius.

Returns:

string | number - Inner radius.
Setter for the inner radius.

Params:

NameTypeDescription
radiusstring | numberInner radius to set.

Returns:

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

isMinor

Getter for the minor grid state flag.

Returns:

boolean - State flag.
Setter for the minor grid state flag.

Params:

NameTypeDefaultDescription
enabledboolean
false
Minor or not.

Returns:

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

isRadial

Whether a grid has the radial layout.

Returns:

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

layout

Getter for the grid layout.

Returns:

anychart.enums.Layout | string - Grid layout.
Setter for the grid layout.

Params:

NameTypeDescription
valueanychart.enums.Layout | stringGrid layout.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

palette

Getter for the colors palette.
See listing
var grid = chart.yGrid();
var palette = grid.palette();
Setter for the grid colors palette.

Params:

NameTypeDescription
settingsanychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string>Grid colors palette settings to set.

Returns:

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

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.
Setter for the parent bounds using single value.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

NameTypeDescription
boundsanychart.math.Rect | Object | number | nullBounds to set.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.
Setter for the parent bounds using several values.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

NameTypeDescription
leftnumberLeft space.
topnumberTop space.
widthnumberElement width.
heightnumberElement height.

Returns:

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

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

startAngle

Getter for the start angle.

Returns:

string | number - Returns the start angle value.
Setter for the start angle.

Params:

NameTypeDescription
anglestring | numberThe start angle value to set.

Returns:

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

stroke

Getter for the grid stroke line.

Returns:

string | anychart.graphics.vector.Stroke - Grid stroke line settings.
Setter for the grid stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#CECECE'
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.standalones.grids.Polar - Self instance for method chaining.
Setter for the grid stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

xScale

Getter for the grid X-scale.

Returns:

anychart.scales.Linear - Grid X-scale.
Setter for the grid X-scale.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | anychart.enums.ScaleTypes | string | Object
anychart.scales.Linear
Scale settings to set.

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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