Polar Type

Namespace: Plotly.NET.LayoutObjects
Assembly: Plotly.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

Constructors

Constructor Description

Polar()

Full Usage: Polar()

Returns: Polar

Returns: Polar

Static members

Static member Description

Polar.getAngularAxis polar

Full Usage: Polar.getAngularAxis polar

Parameters:
    polar : Polar - The polar object to get the AngularAxis from

Returns: AngularAxis

Returns the AngularAxis object of the given polar object. If there is no AngularAxis set, returns an empty AngularAxis object.

polar : Polar

The polar object to get the AngularAxis from

Returns: AngularAxis

Polar.getRadialAxis polar

Full Usage: Polar.getRadialAxis polar

Parameters:
    polar : Polar - The polar object to get the RadialAxis from

Returns: RadialAxis

Returns the RadialAxis object of the given polar object. If there is no RadialAxis set, returns an empty RadialAxis object.

polar : Polar

The polar object to get the RadialAxis from

Returns: RadialAxis

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

Full Usage: Polar.setAngularAxis angularAxis

Parameters:
    angularAxis : AngularAxis - The new AngularAxis object

Returns: Polar -> Polar

Returns a function that sets the AngularAxis object of the given polar object.

angularAxis : AngularAxis

The new AngularAxis object

Returns: Polar -> Polar

Polar.setRadialAxis radialAxis

Full Usage: Polar.setRadialAxis radialAxis

Parameters:
    radialAxis : RadialAxis - The new RadialAxis object

Returns: Polar -> Polar

Returns a function that sets the RadialAxis object of the given polar object.

radialAxis : RadialAxis

The new RadialAxis object

Returns: Polar -> 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

Polar.tryGetTypedMember propName polar

Full Usage: Polar.tryGetTypedMember propName polar

Parameters:
    propName : string - The name of the dynamic member to get the value of
    polar : Polar - The object to get the dynamic member value from

Returns: 'T option

Returns Some(dynamic member value) of the object's underlying DynamicObj when a dynamic member with the given name exists, and None otherwise.

propName : string

The name of the dynamic member to get the value of

polar : Polar

The object to get the dynamic member value from

Returns: 'T option