Polar Type

Constructors

Constructor Description

Polar()

Full Usage: Polar()

Returns: Polar
Returns: Polar

Static members

Static member Description

Polar.init (?Domain, ?Sector, ?Hole, ?BGColor, ?RadialAxis, ?AngularAxis, ?GridShape, ?UIRevision)

Full Usage: Polar.init (?Domain, ?Sector, ?Hole, ?BGColor, ?RadialAxis, ?AngularAxis, ?GridShape, ?UIRevision)

Parameters:
    ?Domain : Domain - Sets the domain of this polar subplot
    ?Sector : float * float - Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.
    ?Hole : float - Sets the fraction of the radius to cut out of the polar subplot.
    ?BGColor : Color - Set the background color of the subplot
    ?RadialAxis : RadialAxis - Sets the radial axis of the polar subplot.
    ?AngularAxis : AngularAxis - Sets the angular axis of the polar subplot.
    ?GridShape : PolarGridShape - Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).
    ?UIRevision : string - Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.

Returns: Polar

Initialize a Polar object that contains layout options concerned with polar plots.

?Domain : Domain

Sets the domain of this polar subplot

?Sector : float * float

Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.

?Hole : float

Sets the fraction of the radius to cut out of the polar subplot.

?BGColor : Color

Set the background color of the subplot

?RadialAxis : RadialAxis

Sets the radial axis of the polar subplot.

?AngularAxis : AngularAxis

Sets the angular axis of the polar subplot.

?GridShape : PolarGridShape

Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).

?UIRevision : string

Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.

Returns: Polar

Polar.style (?Domain, ?Sector, ?Hole, ?BGColor, ?RadialAxis, ?AngularAxis, ?GridShape, ?UIRevision, ?BarMode, ?BarGap)

Full Usage: Polar.style (?Domain, ?Sector, ?Hole, ?BGColor, ?RadialAxis, ?AngularAxis, ?GridShape, ?UIRevision, ?BarMode, ?BarGap)

Parameters:
    ?Domain : Domain - Sets the domain of this polar subplot
    ?Sector : float * float - Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.
    ?Hole : float - Sets the fraction of the radius to cut out of the polar subplot.
    ?BGColor : Color - Set the background color of the subplot
    ?RadialAxis : RadialAxis - Sets the radial axis of the polar subplot.
    ?AngularAxis : AngularAxis - Sets the angular axis of the polar subplot.
    ?GridShape : PolarGridShape - Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).
    ?UIRevision : string - Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.
    ?BarMode : BarMode - Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars.
    ?BarGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.

Returns: Polar -> Polar

Create a function that applies the given style parameters to a Polar object

?Domain : Domain

Sets the domain of this polar subplot

?Sector : float * float

Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.

?Hole : float

Sets the fraction of the radius to cut out of the polar subplot.

?BGColor : Color

Set the background color of the subplot

?RadialAxis : RadialAxis

Sets the radial axis of the polar subplot.

?AngularAxis : AngularAxis

Sets the angular axis of the polar subplot.

?GridShape : PolarGridShape

Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).

?UIRevision : string

Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.

?BarMode : BarMode

Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars.

?BarGap : float

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

Returns: Polar -> Polar