RealAxis (Plotly.NET) | Plotly.NET

RealAxis Type

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

Angular axes can be used as a scale for the angular coordinates in polar plots.

Constructors

Constructor	Description
`RealAxis()` Full Usage: `RealAxis()` Returns: `RealAxis`	Returns: `RealAxis`

Static members

Static member	Description
`RealAxis.init (?Color, ?GridColor, ?GridDash, ?GridWidth, ?HoverFormat, ?LabelAlias, ?Layer, ?LineColor, ?LineWidth, ?ShowGrid, ?ShowLine, ?ShowTickLabels, ?ShowTickSuffix, ?ShowTickPrefix, ?Side, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickLen, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickVals, ?TickWidth, ?Visible)` Full Usage: `RealAxis.init (?Color, ?GridColor, ?GridDash, ?GridWidth, ?HoverFormat, ?LabelAlias, ?Layer, ?LineColor, ?LineWidth, ?ShowGrid, ?ShowLine, ?ShowTickLabels, ?ShowTickSuffix, ?ShowTickPrefix, ?Side, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickLen, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickVals, ?TickWidth, ?Visible)` Parameters: ?Color : `Color` - Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. ?GridColor : `Color` - Sets the color of the grid lines. ?GridDash : `DrawingStyle` - Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?GridWidth : `int` - Sets the width (in px) of the grid lines. ?HoverFormat : `string` - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?LabelAlias : `DynamicObj` - Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax. ?Layer : `Layer` - Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis. ?LineColor : `Color` - Sets the axis line color. ?LineWidth : `int` - Sets the width (in px) of the axis line. ?ShowGrid : `bool` - Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark. ?ShowLine : `bool` - Determines whether or not a line bounding this axis is drawn. ?ShowTickLabels : `bool` - Determines whether or not the tick labels are drawn. ?ShowTickSuffix : `ShowTickOption` - If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. ?ShowTickPrefix : `ShowTickOption` - Same as `showtickprefix` but for tick suffixes. ?Side : `Side` - Determines on which side of real axis line the tick and tick labels appear. ?TickAngle : `int` - Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. ?TickColor : `Color` - Sets the tick color. ?TickFont : `Font` - Sets the tick font. ?TickFormat : `string` - Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?TickLen : `int` - Sets the tick length (in px). ?TickPrefix : `string` - Sets a tick label prefix. ?Ticks : `TickLabelPosition` - Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ?TickSuffix : `string` - Sets a tick label suffix. ?TickVals : `'a seq` - Sets the values at which ticks on this axis appear. Defaults to `realaxis.tickvals` plus the same as negatives and zero. ?TickWidth : `int` - Sets the tick width (in px). ?Visible : `bool` - A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false Returns: `RealAxis`	Initialize an RealAxis object that can be used as a real scale for smith coordinates. ?Color : `Color` Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. ?GridColor : `Color` Sets the color of the grid lines. ?GridDash : `DrawingStyle` Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?GridWidth : `int` Sets the width (in px) of the grid lines. ?HoverFormat : `string` Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?LabelAlias : `DynamicObj` Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax. ?Layer : `Layer` Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis. ?LineColor : `Color` Sets the axis line color. ?LineWidth : `int` Sets the width (in px) of the axis line. ?ShowGrid : `bool` Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark. ?ShowLine : `bool` Determines whether or not a line bounding this axis is drawn. ?ShowTickLabels : `bool` Determines whether or not the tick labels are drawn. ?ShowTickSuffix : `ShowTickOption` If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. ?ShowTickPrefix : `ShowTickOption` Same as `showtickprefix` but for tick suffixes. ?Side : `Side` Determines on which side of real axis line the tick and tick labels appear. ?TickAngle : `int` Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. ?TickColor : `Color` Sets the tick color. ?TickFont : `Font` Sets the tick font. ?TickFormat : `string` Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?TickLen : `int` Sets the tick length (in px). ?TickPrefix : `string` Sets a tick label prefix. ?Ticks : `TickLabelPosition` Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ?TickSuffix : `string` Sets a tick label suffix. ?TickVals : `'a seq` Sets the values at which ticks on this axis appear. Defaults to `realaxis.tickvals` plus the same as negatives and zero. ?TickWidth : `int` Sets the tick width (in px). ?Visible : `bool` A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false Returns: `RealAxis`
`RealAxis.style (?Color, ?GridColor, ?GridDash, ?GridWidth, ?HoverFormat, ?LabelAlias, ?Layer, ?LineColor, ?LineWidth, ?ShowGrid, ?ShowLine, ?ShowTickLabels, ?ShowTickSuffix, ?ShowTickPrefix, ?Side, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickLen, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickVals, ?TickWidth, ?Visible)` Full Usage: `RealAxis.style (?Color, ?GridColor, ?GridDash, ?GridWidth, ?HoverFormat, ?LabelAlias, ?Layer, ?LineColor, ?LineWidth, ?ShowGrid, ?ShowLine, ?ShowTickLabels, ?ShowTickSuffix, ?ShowTickPrefix, ?Side, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickLen, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickVals, ?TickWidth, ?Visible)` Parameters: ?Color : `Color` - Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. ?GridColor : `Color` - Sets the color of the grid lines. ?GridDash : `DrawingStyle` - Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?GridWidth : `int` - Sets the width (in px) of the grid lines. ?HoverFormat : `string` - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?LabelAlias : `DynamicObj` - Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax. ?Layer : `Layer` - Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis. ?LineColor : `Color` - Sets the axis line color. ?LineWidth : `int` - Sets the width (in px) of the axis line. ?ShowGrid : `bool` - Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark. ?ShowLine : `bool` - Determines whether or not a line bounding this axis is drawn. ?ShowTickLabels : `bool` - Determines whether or not the tick labels are drawn. ?ShowTickSuffix : `ShowTickOption` - If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. ?ShowTickPrefix : `ShowTickOption` - Same as `showtickprefix` but for tick suffixes. ?Side : `Side` - Determines on which side of real axis line the tick and tick labels appear. ?TickAngle : `int` - Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. ?TickColor : `Color` - Sets the tick color. ?TickFont : `Font` - Sets the tick font. ?TickFormat : `string` - Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?TickLen : `int` - Sets the tick length (in px). ?TickPrefix : `string` - Sets a tick label prefix. ?Ticks : `TickLabelPosition` - Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ?TickSuffix : `string` - Sets a tick label suffix. ?TickVals : `'a seq` - Sets the values at which ticks on this axis appear. Defaults to `realaxis.tickvals` plus the same as negatives and zero. ?TickWidth : `int` - Sets the tick width (in px). ?Visible : `bool` - A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false Returns: `RealAxis -> RealAxis`	Creates a function that applies the given style parameters to a RealAxis object ?Color : `Color` Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. ?GridColor : `Color` Sets the color of the grid lines. ?GridDash : `DrawingStyle` Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?GridWidth : `int` Sets the width (in px) of the grid lines. ?HoverFormat : `string` Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?LabelAlias : `DynamicObj` Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax. ?Layer : `Layer` Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis. ?LineColor : `Color` Sets the axis line color. ?LineWidth : `int` Sets the width (in px) of the axis line. ?ShowGrid : `bool` Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark. ?ShowLine : `bool` Determines whether or not a line bounding this axis is drawn. ?ShowTickLabels : `bool` Determines whether or not the tick labels are drawn. ?ShowTickSuffix : `ShowTickOption` If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden. ?ShowTickPrefix : `ShowTickOption` Same as `showtickprefix` but for tick suffixes. ?Side : `Side` Determines on which side of real axis line the tick and tick labels appear. ?TickAngle : `int` Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. ?TickColor : `Color` Sets the tick color. ?TickFont : `Font` Sets the tick font. ?TickFormat : `string` Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46" ?TickLen : `int` Sets the tick length (in px). ?TickPrefix : `string` Sets a tick label prefix. ?Ticks : `TickLabelPosition` Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ?TickSuffix : `string` Sets a tick label suffix. ?TickVals : `'a seq` Sets the values at which ticks on this axis appear. Defaults to `realaxis.tickvals` plus the same as negatives and zero. ?TickWidth : `int` Sets the tick width (in px). ?Visible : `bool` A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false Returns: `RealAxis -> RealAxis`