LinearAxis Type
Linear axes can be used as x and y scales on 2D plots, and as x,y, and z scales on 3D plots.
Constructors
Constructor | Description |
|
|
Static members
Static member | Description |
Full Usage:
LinearAxis.init (?Visible, ?Color, ?Title, ?AxisType, ?AutoTypeNumbers, ?AutoRange, ?AutoRangeOptions, ?AutoShift, ?RangeMode, ?Range, ?FixedRange, ?ScaleAnchor, ?ScaleRatio, ?Constrain, ?ConstrainToward, ?Matches, ?MaxAllowed, ?MinAllowed, ?Rangebreaks, ?TickMode, ?NTicks, ?Tick0, ?DTick, ?TickVals, ?TickText, ?Ticks, ?TicksOn, ?TickLabelMode, ?TickLabelPosition, ?TickLabelStep, ?TickLabelOverflow, ?Mirror, ?TickLen, ?TickWidth, ?TickColor, ?ShowTickLabels, ?AutoMargin, ?ShowSpikes, ?SpikeColor, ?SpikeThickness, ?SpikeDash, ?SpikeMode, ?SpikeSnap, ?TickFont, ?TickAngle, ?ShowTickPrefix, ?TickPrefix, ?ShowTickSuffix, ?TickSuffix, ?ShowExponent, ?ExponentFormat, ?MinExponent, ?Minor, ?SeparateThousands, ?TickFormat, ?TickFormatStops, ?HoverFormat, ?InsideRange, ?ShowLine, ?LineColor, ?LineWidth, ?ShowGrid, ?GridColor, ?GridDash, ?GridWidth, ?ZeroLine, ?ZeroLineColor, ?ZeroLineWidth, ?Shift, ?ShowDividers, ?DividerColor, ?DividerWidth, ?Anchor, ?Side, ?Overlaying, ?LabelAlias, ?Layer, ?Domain, ?Position, ?CategoryOrder, ?CategoryArray, ?UIRevision, ?RangeSlider, ?RangeSelector, ?Calendar, ?BackgroundColor, ?ShowBackground)
Parameters:
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
?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.
?Title : Title
-
Sets the axis title.
?AxisType : AxisType
-
Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
?AutoTypeNumbers : AutoTypeNumbers
-
Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.
?AutoRange : AutoRange
-
Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".
?AutoRangeOptions : AutoRangeOptions
-
Additional options for bounding the autorange
?AutoShift : bool
-
Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to true. Only has an effect if `anchor` is set to "free".
?RangeMode : RangeMode
-
If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
?Range : Range
-
Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
?FixedRange : bool
-
Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
?ScaleAnchor : ScaleAnchor
-
If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Setting `false` allows to remove a default constraint (occasionally, you may need to prevent a default `scaleanchor` constraint from being applied, eg. when having an image trace `yaxis: {scaleanchor: "x"}` is set automatically in order for pixels to be rendered as squares, setting `yaxis: {scaleanchor: false}` allows to remove the constraint).
?ScaleRatio : float
-
If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.
?Constrain : AxisConstraint
-
If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range", or by decreasing the "domain". Default is "domain" for axes containing image traces, "range" otherwise.
?ConstrainToward : AxisConstraintDirection
-
If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes.
?Matches : LinearAxisId
-
If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.
?MaxAllowed : 'a
-
Determines the maximum range of this axis.
?MinAllowed : 'b
-
Determines the minimum range of this axis.
?Rangebreaks : Rangebreak seq
-
Sets breaks in the axis range
?TickMode : TickMode
-
Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). If "sync", the number of ticks will sync with the overlayed axis set by `overlaying` property.
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Tick0 : 'c
-
Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L?DTick : 'd
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L?TickVals : 'e seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `TickText`.
?TickText : 'f seq
-
Sets the text displayed at the ticks position via `TickVals`. Only has an effect if `tickmode` is set to "array". Used with `TickVals`.
?Ticks : TickOptions
-
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.
?TicksOn : CategoryTickAnchor
-
Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels.
?TickLabelMode : TickLabelMode
-
Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` "date" When set to "period", tick labels are drawn in the middle of the period between ticks.
?TickLabelPosition : TickLabelPosition
-
Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when `ticklabelmode` is set to "period". Similarly left or right has no effect on y axes or when `ticklabelmode` is set to "period". Has no effect on "multicategory" axes or when `tickson` is set to "boundaries". When used on axes linked by `matches` or `scaleanchor`, no extra padding for inside labels would be added by autorange, so that the scales could match.
?TickLabelStep : int
-
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array".
?TickLabelOverflow : TickLabelOverflow
-
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". Otherwise on "category" and "multicategory" axes the default is "allow". In other cases the default is "hide past div".
?Mirror : Mirror
-
Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
?TickLen : int
-
Sets the tick length (in px).
?TickWidth : int
-
Sets the tick width (in px).
?TickColor : Color
-
Sets the tick color.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?AutoMargin : TickAutoMargin
-
Determines whether long tick labels automatically grow the figure margins.
?ShowSpikes : bool
-
Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
?SpikeColor : Color
-
Sets the spike color. If undefined, will use the series color
?SpikeThickness : int
-
Sets the width (in px) of the zero line.
?SpikeDash : DrawingStyle
-
Sets the dash style of lines
?SpikeMode : SpikeMode
-
Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on
?SpikeSnap : SpikeSnap
-
Determines whether spikelines are stuck to the cursor or to the closest datapoints.
?TickFont : Font
-
Sets the tick font.
?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.
?ShowTickPrefix : 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.
?TickPrefix : string
-
Sets a tick label prefix.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?TickSuffix : string
-
Sets a tick label suffix.
?ShowExponent : ShowExponent
-
If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
?ExponentFormat : ExponentFormat
-
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `TickFormat` is "SI" or "B".
?Minor : Minor
-
Holds various parameters to style minor ticks on this axis.
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?InsideRange : Range
-
Could be used to set the desired inside range of this axis (excluding the labels) when `ticklabelposition` of the anchored axis has "inside". Not implemented for axes with `type` "log". This would be ignored when `range` is provided.
?ShowLine : bool
-
Determines whether or not a line bounding this axis is drawn.
?LineColor : Color
-
Sets the axis line color.
?LineWidth : float
-
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.
?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 : float
-
Sets the width (in px) of the grid lines.
?ZeroLine : bool
-
Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.
?ZeroLineColor : Color
-
Sets the line color of the zero line.
?ZeroLineWidth : float
-
Sets the width (in px) of the zero line.
?Shift : int
-
Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift` is set to true, then this defaults to a padding of -3 if `side` is set to "left". and defaults to +3 if `side` is set to "right". Defaults to 0 if `autoshift` is set to false. Only has an effect if `anchor` is set to "free".
?ShowDividers : bool
-
Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes.
?DividerColor : Color
-
Sets the color of the dividers Only has an effect on "multicategory" axes.
?DividerWidth : int
-
Sets the width (in px) of the dividers Only has an effect on "multicategory" axes.
?Anchor : LinearAxisId
-
If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
?Side : Side
-
Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
?Overlaying : LinearAxisId
-
If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
?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.
?Domain : Range
-
Sets the domain of this axis (in plot fraction).
?Position : float
-
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
?CategoryOrder : CategoryOrder
-
Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
?CategoryArray : 'g seq
-
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
?UIRevision : 'h
-
Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`.
?RangeSlider : RangeSlider
-
Sets a range slider for this axis
?RangeSelector : RangeSelector
-
Sets a range selector for this axis. This object contains toggable presets for the rangeslider.
?Calendar : Calendar
-
Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
?BackgroundColor : Color
-
Sets the background color of this axis' wall. (Only has an effect on 3D scenes)
?ShowBackground : bool
-
Sets whether or not this axis' wall has a background color. (Only has an effect on 3D scenes)
Returns: LinearAxis
|
|
Full Usage:
LinearAxis.initCarpet (?Color, ?Title, ?AxisType, ?AutoTypeNumbers, ?AutoRange, ?RangeMode, ?Range, ?FixedRange, ?TickMode, ?NTicks, ?Tick0, ?DTick, ?TickVals, ?TickText, ?Ticks, ?ShowTickLabels, ?TickFont, ?TickAngle, ?ShowTickPrefix, ?TickPrefix, ?ShowTickSuffix, ?TickSuffix, ?ShowExponent, ?ExponentFormat, ?MinExponent, ?SeparateThousands, ?TickFormat, ?TickFormatStops, ?ShowLine, ?LineColor, ?LineWidth, ?ShowGrid, ?GridColor, ?GridDash, ?GridWidth, ?CategoryOrder, ?CategoryArray, ?ArrayDTick, ?ArrayTick0, ?CheaterType, ?EndLine, ?EndLineColor, ?EndLineWidth, ?LabelAlias, ?LabelPadding, ?LabelPrefix, ?LabelSuffix, ?MinorGridColor, ?MinorGridDash, ?MinorGridCount, ?MinorGridWidth, ?Smoothing, ?StartLine, ?StartLineColor, ?StartLineWidth)
Parameters:
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.
?Title : Title
-
Sets the axis title.
?AxisType : AxisType
-
Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
?AutoTypeNumbers : AutoTypeNumbers
-
Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.
?AutoRange : AutoRange
-
Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".
?RangeMode : RangeMode
-
If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
?Range : Range
-
Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
?FixedRange : bool
-
Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
?TickMode : TickMode
-
Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `TickVals` and the tick text is `TickText`. ("array" is the default value if `TickVals` is provided).
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Tick0 : 'a
-
Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L?DTick : 'b
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L?TickVals : 'c seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `TickText`.
?TickText : 'd seq
-
Sets the text displayed at the ticks position via `TickVals`. Only has an effect if `tickmode` is set to "array". Used with `TickVals`.
?Ticks : TickOptions
-
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.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?TickFont : Font
-
Sets the tick font.
?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.
?ShowTickPrefix : 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.
?TickPrefix : string
-
Sets a tick label prefix.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?TickSuffix : string
-
Sets a tick label suffix.
?ShowExponent : ShowExponent
-
If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
?ExponentFormat : ExponentFormat
-
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `TickFormat` is "SI" or "B".
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?ShowLine : bool
-
Determines whether or not a line bounding this axis is drawn.
?LineColor : Color
-
Sets the axis line color.
?LineWidth : float
-
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.
?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 : float
-
Sets the width (in px) of the grid lines.
?CategoryOrder : CategoryOrder
-
Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
?CategoryArray : 'e seq
-
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
?ArrayDTick : int
-
The stride between grid lines along the axis
?ArrayTick0 : int
-
The starting index of grid lines along the axis
?CheaterType : CheaterType
-
The type of cheater plot when interpreted as cheater plot
?EndLine : bool
-
Determines whether or not a line is drawn at along the final value of this axis. If "true", the end line is drawn on top of the grid lines.
?EndLineColor : Color
-
Sets the line color of the end line.
?EndLineWidth : int
-
Sets the width (in px) of the end line.
?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.
?LabelPadding : int
-
Extra padding between label and the axis
?LabelPrefix : string
-
Sets a axis label prefix.
?LabelSuffix : string
-
Sets a axis label suffix.
?MinorGridColor : Color
-
Sets the color of the grid lines.
?MinorGridDash : DrawingStyle
-
Sets the dash style of minor grid 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").
?MinorGridCount : int
-
Sets the number of minor grid ticks per major grid tick
?MinorGridWidth : int
-
Sets the width (in px) of the grid lines.
?Smoothing : float
-
Smoothing applied to the axis lines
?StartLine : bool
-
Determines whether or not a line is drawn at along the starting value of this axis. If "true", the start line is drawn on top of the grid lines.
?StartLineColor : Color
-
Sets the line color of the start line.
?StartLineWidth : int
-
Sets the width (in px) of the start line.
Returns: LinearAxis
|
|
Full Usage:
LinearAxis.initCategorical (categoryOrder, ?Visible, ?Color, ?Title, ?AutoTypeNumbers, ?AutoRange, ?AutoShift, ?RangeMode, ?Range, ?FixedRange, ?ScaleAnchor, ?ScaleRatio, ?Constrain, ?ConstrainToward, ?Matches, ?Rangebreaks, ?TickMode, ?NTicks, ?Tick0, ?DTick, ?TickVals, ?TickText, ?Ticks, ?TicksOn, ?TickLabelMode, ?TickLabelPosition, ?TickLabelOverflow, ?Mirror, ?TickLen, ?TickWidth, ?TickColor, ?ShowTickLabels, ?AutoMargin, ?ShowSpikes, ?SpikeColor, ?SpikeThickness, ?SpikeDash, ?SpikeMode, ?SpikeSnap, ?TickFont, ?TickAngle, ?ShowTickPrefix, ?TickPrefix, ?ShowTickSuffix, ?TickSuffix, ?ShowExponent, ?ExponentFormat, ?MinExponent, ?Minor, ?SeparateThousands, ?TickFormat, ?TickFormatStops, ?HoverFormat, ?ShowLine, ?LineColor, ?LineWidth, ?ShowGrid, ?GridColor, ?GridDash, ?GridWidth, ?ZeroLine, ?ZeroLineColor, ?ZeroLineWidth, ?Shift, ?ShowDividers, ?DividerColor, ?DividerWidth, ?Anchor, ?Side, ?Overlaying, ?LabelAlias, ?Layer, ?Domain, ?Position, ?CategoryArray, ?UIRevision, ?RangeSlider, ?RangeSelector, ?Calendar)
Parameters:
CategoryOrder
-
Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
?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
?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.
?Title : Title
-
Sets the axis title.
?AutoTypeNumbers : AutoTypeNumbers
-
Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.
?AutoRange : AutoRange
-
Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".
?AutoShift : bool
-
Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to true. Only has an effect if `anchor` is set to "free".
?RangeMode : RangeMode
-
If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
?Range : Range
-
Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
?FixedRange : bool
-
Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
?ScaleAnchor : ScaleAnchor
-
If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Setting `false` allows to remove a default constraint (occasionally, you may need to prevent a default `scaleanchor` constraint from being applied, eg. when having an image trace `yaxis: {scaleanchor: "x"}` is set automatically in order for pixels to be rendered as squares, setting `yaxis: {scaleanchor: false}` allows to remove the constraint).
?ScaleRatio : float
-
If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.
?Constrain : AxisConstraint
-
If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range", or by decreasing the "domain". Default is "domain" for axes containing image traces, "range" otherwise.
?ConstrainToward : AxisConstraintDirection
-
If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes.
?Matches : LinearAxisId
-
If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.
?Rangebreaks : Rangebreak seq
-
Sets breaks in the axis range
?TickMode : TickMode
-
Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided). If "sync", the number of ticks will sync with the overlayed axis set by `overlaying` property.
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Tick0 : 'a
-
Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L?DTick : 'b
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L?TickVals : 'c seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `TickText`.
?TickText : 'd seq
-
Sets the text displayed at the ticks position via `TickVals`. Only has an effect if `tickmode` is set to "array". Used with `TickVals`.
?Ticks : TickOptions
-
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.
?TicksOn : CategoryTickAnchor
-
Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels.
?TickLabelMode : TickLabelMode
-
Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` "date" When set to "period", tick labels are drawn in the middle of the period between ticks.
?TickLabelPosition : TickLabelPosition
-
Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when `ticklabelmode` is set to "period". Similarly left or right has no effect on y axes or when `ticklabelmode` is set to "period". Has no effect on "multicategory" axes or when `tickson` is set to "boundaries". When used on axes linked by `matches` or `scaleanchor`, no extra padding for inside labels would be added by autorange, so that the scales could match.
?TickLabelOverflow : TickLabelOverflow
-
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". Otherwise on "category" and "multicategory" axes the default is "allow". In other cases the default is "hide past div".
?Mirror : Mirror
-
Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
?TickLen : int
-
Sets the tick length (in px).
?TickWidth : int
-
Sets the tick width (in px).
?TickColor : Color
-
Sets the tick color.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?AutoMargin : TickAutoMargin
-
Determines whether long tick labels automatically grow the figure margins.
?ShowSpikes : bool
-
Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
?SpikeColor : Color
-
Sets the spike color. If undefined, will use the series color
?SpikeThickness : int
-
Sets the width (in px) of the zero line.
?SpikeDash : DrawingStyle
-
Sets the dash style of lines
?SpikeMode : SpikeMode
-
Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on
?SpikeSnap : SpikeSnap
-
Determines whether spikelines are stuck to the cursor or to the closest datapoints.
?TickFont : Font
-
Sets the tick font.
?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.
?ShowTickPrefix : 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.
?TickPrefix : string
-
Sets a tick label prefix.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?TickSuffix : string
-
Sets a tick label suffix.
?ShowExponent : ShowExponent
-
If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
?ExponentFormat : ExponentFormat
-
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `TickFormat` is "SI" or "B".
?Minor : Minor
-
Holds various parameters to style minor ticks on this axis.
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?ShowLine : bool
-
Determines whether or not a line bounding this axis is drawn.
?LineColor : Color
-
Sets the axis line color.
?LineWidth : float
-
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.
?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 : float
-
Sets the width (in px) of the grid lines.
?ZeroLine : bool
-
Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.
?ZeroLineColor : Color
-
Sets the line color of the zero line.
?ZeroLineWidth : float
-
Sets the width (in px) of the zero line.
?Shift : int
-
Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift` is set to true, then this defaults to a padding of -3 if `side` is set to "left". and defaults to +3 if `side` is set to "right". Defaults to 0 if `autoshift` is set to false. Only has an effect if `anchor` is set to "free".
?ShowDividers : bool
-
Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes.
?DividerColor : Color
-
Sets the color of the dividers Only has an effect on "multicategory" axes.
?DividerWidth : int
-
Sets the width (in px) of the dividers Only has an effect on "multicategory" axes.
?Anchor : LinearAxisId
-
If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
?Side : Side
-
Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
?Overlaying : LinearAxisId
-
If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
?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.
?Domain : Range
-
Sets the domain of this axis (in plot fraction).
?Position : float
-
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
?CategoryArray : 'e seq
-
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
?UIRevision : 'f
-
Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`.
?RangeSlider : RangeSlider
-
Sets a range slider for this axis
?RangeSelector : RangeSelector
-
Sets a range selector for this axis. This object contains toggable presets for the rangeslider.
?Calendar : Calendar
-
Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
Returns: LinearAxis
|
|
Full Usage:
LinearAxis.initIndicatorGauge (?DTick, ?LabelAlias, ?ExponentFormat, ?MinExponent, ?NTicks, ?Range, ?SeparateThousands, ?ShowExponent, ?ShowTickLabels, ?ShowTickPrefix, ?ShowTickSuffix, ?Tick0, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickFormatStops, ?TickLen, ?TickMode, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickText, ?TickVals, ?TickWidth, ?Visible)
Parameters:
'a
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L?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.
?ExponentFormat : ExponentFormat
-
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `TickFormat` is "SI" or "B".
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Range : Range
-
Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?ShowExponent : ShowExponent
-
If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?ShowTickPrefix : 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.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?Tick0 : 'b
-
Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?TickLen : int
-
Sets the tick length (in px).
?TickMode : TickMode
-
Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `TickVals` and the tick text is `TickText`. ("array" is the default value if `TickVals` is provided).
?TickPrefix : string
-
Sets a tick label prefix.
?Ticks : TickOptions
-
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.
?TickText : 'c seq
-
Sets the text displayed at the ticks position via `TickVals`. Only has an effect if `tickmode` is set to "array". Used with `TickVals`.
?TickVals : 'd seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `TickText`.
?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: LinearAxis
|
|
Full Usage:
LinearAxis.style (?Visible, ?Color, ?Title, ?AxisType, ?AutoTypeNumbers, ?AutoRange, ?AutoRangeOptions, ?AutoShift, ?RangeMode, ?Range, ?FixedRange, ?ScaleAnchor, ?ScaleRatio, ?Constrain, ?ConstrainToward, ?Matches, ?MaxAllowed, ?MinAllowed, ?Rangebreaks, ?TickMode, ?NTicks, ?Tick0, ?DTick, ?TickVals, ?TickText, ?Ticks, ?TicksOn, ?TickLabelMode, ?TickLabelPosition, ?TickLabelStep, ?TickLabelOverflow, ?Mirror, ?TickLen, ?TickWidth, ?TickColor, ?ShowTickLabels, ?AutoMargin, ?ShowSpikes, ?SpikeColor, ?SpikeThickness, ?SpikeDash, ?SpikeMode, ?SpikeSnap, ?TickFont, ?TickAngle, ?ShowTickPrefix, ?TickPrefix, ?ShowTickSuffix, ?TickSuffix, ?ShowExponent, ?ExponentFormat, ?MinExponent, ?Minor, ?SeparateThousands, ?TickFormat, ?TickFormatStops, ?HoverFormat, ?InsideRange, ?ShowLine, ?LineColor, ?LineWidth, ?ShowGrid, ?GridColor, ?GridDash, ?GridWidth, ?ZeroLine, ?ZeroLineColor, ?ZeroLineWidth, ?Shift, ?ShowDividers, ?DividerColor, ?DividerWidth, ?Anchor, ?Side, ?Overlaying, ?LabelAlias, ?Layer, ?Domain, ?Position, ?CategoryOrder, ?CategoryArray, ?UIRevision, ?RangeSlider, ?RangeSelector, ?Calendar, ?ArrayDTick, ?ArrayTick0, ?CheaterType, ?EndLine, ?EndLineColor, ?EndLineWidth, ?LabelPadding, ?LabelPrefix, ?LabelSuffix, ?MinorGridColor, ?MinorGridDash, ?MinorGridCount, ?MinorGridWidth, ?Smoothing, ?StartLine, ?StartLineColor, ?StartLineWidth, ?BackgroundColor, ?ShowBackground)
Parameters:
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
?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.
?Title : Title
-
Sets the axis title.
?AxisType : AxisType
-
Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
?AutoTypeNumbers : AutoTypeNumbers
-
Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.
?AutoRange : AutoRange
-
Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".
?AutoRangeOptions : AutoRangeOptions
-
Additional options for bounding the autorange
?AutoShift : bool
-
Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to true. Only has an effect if `anchor` is set to "free".
?RangeMode : RangeMode
-
If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
?Range : Range
-
Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
?FixedRange : bool
-
Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
?ScaleAnchor : ScaleAnchor
-
If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Setting `false` allows to remove a default constraint (occasionally, you may need to prevent a default `scaleanchor` constraint from being applied, eg. when having an image trace `yaxis: {scaleanchor: "x"}` is set automatically in order for pixels to be rendered as squares, setting `yaxis: {scaleanchor: false}` allows to remove the constraint).
?ScaleRatio : float
-
If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.
?Constrain : AxisConstraint
-
If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range", or by decreasing the "domain". Default is "domain" for axes containing image traces, "range" otherwise.
?ConstrainToward : AxisConstraintDirection
-
If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes.
?Matches : LinearAxisId
-
If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.
?MaxAllowed : 'a
-
Determines the maximum range of this axis.
?MinAllowed : 'b
-
Determines the minimum range of this axis.
?Rangebreaks : Rangebreak seq
-
Sets breaks in the axis range
?TickMode : TickMode
-
Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `TickVals` and the tick text is `TickText`. ("array" is the default value if `TickVals` is provided).
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Tick0 : 'c
-
Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L?DTick : 'd
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L?TickVals : 'e seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `TickText`.
?TickText : 'f seq
-
Sets the text displayed at the ticks position via `TickVals`. Only has an effect if `tickmode` is set to "array". Used with `TickVals`.
?Ticks : TickOptions
-
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.
?TicksOn : CategoryTickAnchor
-
Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels.
?TickLabelMode : TickLabelMode
-
Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` "date" When set to "period", tick labels are drawn in the middle of the period between ticks.
?TickLabelPosition : TickLabelPosition
-
Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when `ticklabelmode` is set to "period". Similarly left or right has no effect on y axes or when `ticklabelmode` is set to "period". Has no effect on "multicategory" axes or when `tickson` is set to "boundaries". When used on axes linked by `matches` or `scaleanchor`, no extra padding for inside labels would be added by autorange, so that the scales could match.
?TickLabelStep : int
-
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array".
?TickLabelOverflow : TickLabelOverflow
-
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". Otherwise on "category" and "multicategory" axes the default is "allow". In other cases the default is "hide past div".
?Mirror : Mirror
-
Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
?TickLen : int
-
Sets the tick length (in px).
?TickWidth : int
-
Sets the tick width (in px).
?TickColor : Color
-
Sets the tick color.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?AutoMargin : TickAutoMargin
-
Determines whether long tick labels automatically grow the figure margins.
?ShowSpikes : bool
-
Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
?SpikeColor : Color
-
Sets the spike color. If undefined, will use the series color
?SpikeThickness : int
-
Sets the width (in px) of the zero line.
?SpikeDash : DrawingStyle
-
Sets the dash style of lines
?SpikeMode : SpikeMode
-
Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on
?SpikeSnap : SpikeSnap
-
Determines whether spikelines are stuck to the cursor or to the closest datapoints.
?TickFont : Font
-
Sets the tick font.
?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.
?ShowTickPrefix : 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.
?TickPrefix : string
-
Sets a tick label prefix.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?TickSuffix : string
-
Sets a tick label suffix.
?ShowExponent : ShowExponent
-
If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
?ExponentFormat : ExponentFormat
-
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `TickFormat` is "SI" or "B".
?Minor : Minor
-
Holds various parameters to style minor ticks on this axis.
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?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-3.x-api-reference/blob/master/Formatting.md#d3_format. And for dates see: https://github.com/d3/d3-time-format#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"
?InsideRange : Range
-
Could be used to set the desired inside range of this axis (excluding the labels) when `ticklabelposition` of the anchored axis has "inside". Not implemented for axes with `type` "log". This would be ignored when `range` is provided.
?ShowLine : bool
-
Determines whether or not a line bounding this axis is drawn.
?LineColor : Color
-
Sets the axis line color.
?LineWidth : float
-
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.
?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 : float
-
Sets the width (in px) of the grid lines.
?ZeroLine : bool
-
Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.
?ZeroLineColor : Color
-
Sets the line color of the zero line.
?ZeroLineWidth : float
-
Sets the width (in px) of the zero line.
?Shift : int
-
Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift` is set to true, then this defaults to a padding of -3 if `side` is set to "left". and defaults to +3 if `side` is set to "right". Defaults to 0 if `autoshift` is set to false. Only has an effect if `anchor` is set to "free".
?ShowDividers : bool
-
Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes.
?DividerColor : Color
-
Sets the color of the dividers Only has an effect on "multicategory" axes.
?DividerWidth : int
-
Sets the width (in px) of the dividers Only has an effect on "multicategory" axes.
?Anchor : LinearAxisId
-
If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
?Side : Side
-
Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
?Overlaying : LinearAxisId
-
If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
?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.
?Domain : Range
-
Sets the domain of this axis (in plot fraction).
?Position : float
-
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
?CategoryOrder : CategoryOrder
-
Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
?CategoryArray : 'g seq
-
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
?UIRevision : 'h
-
Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`.
?RangeSlider : RangeSlider
-
Sets a range slider for this axis
?RangeSelector : RangeSelector
-
Sets a range selector for this axis. This object contains toggable presets for the rangeslider.
?Calendar : Calendar
-
Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
?ArrayDTick : int
-
The stride between grid lines along the axis
?ArrayTick0 : int
-
The starting index of grid lines along the axis
?CheaterType : CheaterType
-
The type of cheater plot when interpreted as cheater plot
?EndLine : bool
-
Determines whether or not a line is drawn at along the final value of this axis. If "true", the end line is drawn on top of the grid lines.
?EndLineColor : Color
-
Sets the line color of the end line.
?EndLineWidth : int
-
Sets the width (in px) of the end line.
?LabelPadding : int
-
Extra padding between label and the axis
?LabelPrefix : string
-
Sets a axis label prefix.
?LabelSuffix : string
-
Sets a axis label suffix.
?MinorGridColor : Color
-
Sets the color of the grid lines.
?MinorGridDash : DrawingStyle
-
Sets the dash style of minor grid 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").
?MinorGridCount : int
-
Sets the number of minor grid ticks per major grid tick
?MinorGridWidth : int
-
Sets the width (in px) of the grid lines.
?Smoothing : float
-
Smoothing applied to the axis lines
?StartLine : bool
-
Determines whether or not a line is drawn at along the starting value of this axis. If "true", the start line is drawn on top of the grid lines.
?StartLineColor : Color
-
Sets the line color of the start line.
?StartLineWidth : int
-
Sets the width (in px) of the start line.
?BackgroundColor : Color
-
Sets the background color of this axis' wall. (Only has an effect on 3D scenes)
?ShowBackground : bool
-
Sets whether or not this axis' wall has a background color. (Only has an effect on 3D scenes)
Returns: LinearAxis -> LinearAxis
|
|