Live Chat

We'll need to share your messages (and your email address if you're logged in) with our live chat provider, Drift. Here's their privacy policy.

If you don't want to do this, you can email us instead at contact@anvil.works.

plotly.graph_objs.layout.scene Module

Functions

plotly.graph_objs.layout.scene.Annotation([visible=], [x=], [y=], [z=], [ax=], [ay=], [xanchor=], [xshift=], [yanchor=], [yshift=], [text=], [textangle=], [font=], [width=], [height=], [opacity=], [align=], [valign=], [bgcolor=], [bordercolor=], [borderpad=], [borderwidth=], [showarrow=], [arrowcolor=], [arrowhead=], [startarrowhead=], [arrowside=], [arrowsize=], [startarrowsize=], [arrowwidth=], [standoff=], [startstandoff=], [hovertext=], [hoverlabel=], [captureevents=], [name=], [templateitemname=]) → Annotation

Create a new ‘Annotation’ object

  • visible - Determines whether or not this annotation is visible.

  • x - Sets the annotation's x position.

  • y - Sets the annotation's y position.

  • z - Sets the annotation's z position.

  • ax - Sets the x component of the arrow tail about the arrow head (in pixels).

  • ay - Sets the y component of the arrow tail about the arrow head (in pixels).

  • xanchor - Sets the text box's horizontal position anchor This anchor binds the `x` position to the *left*, *center* or *right* of the annotation. For example, if `x` is set to 1, `xref` to *paper* and `xanchor` to *right* then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If *auto*, the anchor is equivalent to *center* for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

  • xshift - Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.

  • yanchor - Sets the text box's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the annotation. For example, if `y` is set to 1, `yref` to *paper* and `yanchor` to *top* then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If *auto*, the anchor is equivalent to *middle* for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

  • yshift - Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.

  • text - Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.

  • textangle - Sets the angle at which the `text` is drawn with respect to the horizontal.

  • font - Sets the annotation text font.

  • width - Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.

  • height - Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.

  • opacity - Sets the opacity of the annotation (text + arrow).

  • align - Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.

  • valign - Sets the vertical alignment of the `text` within the box. Has an effect only if an explicit height is set to override the text height.

  • bgcolor - Sets the background color of the annotation.

  • bordercolor - Sets the color of the border enclosing the annotation `text`.

  • borderpad - Sets the padding (in px) between the `text` and the enclosing border.

  • borderwidth - Sets the width (in px) of the border enclosing the annotation `text`.

  • showarrow - Determines whether or not the annotation is drawn with an arrow. If *true*, `text` is placed near the arrow's tail. If *false*, `text` lines up with the `x` and `y` provided.

  • arrowcolor - Sets the color of the annotation arrow.

  • arrowhead - Sets the end annotation arrow head style.

  • startarrowhead - Sets the start annotation arrow head style.

  • arrowside - Sets the annotation arrow head position.

  • arrowsize - Sets the size of the end annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.

  • startarrowsize - Sets the size of the start annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.

  • arrowwidth - Sets the width (in px) of annotation arrow line.

  • standoff - Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.

  • startstandoff - Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.

  • hovertext - Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.

  • captureevents - Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default `captureevents` is *false* unless `hovertext` is provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`.

  • name - When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.

  • templateitemname - Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.


plotly.graph_objs.layout.scene.Aspectratio([x=], [y=], [z=], [impliedEdits=]) → Aspectratio

Create a new ‘Aspectratio’ object


    plotly.graph_objs.layout.scene.Camera([up=], [center=], [eye=], [projection=]) → Camera

    Create a new ‘Camera’ object

    • up - Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene with respect to the page. The default is *{x: 0, y: 0, z: 1}* which means that the z axis points up.

    • center - Sets the (x,y,z) components of the 'center' camera vector This vector determines the translation (x,y,z) space about the center of this scene. By default, there is no such translation.

    • eye - Sets the (x,y,z) components of the 'eye' camera vector. This vector determines the view point about the origin of this scene.


    plotly.graph_objs.layout.scene.Domain([x=], [y=], [row=], [column=]) → Domain

    Create a new ‘Domain’ object

    • x - Sets the horizontal domain of this scene subplot (in plot fraction).

    • y - Sets the vertical domain of this scene subplot (in plot fraction).

    • row - If there is a layout grid, use the domain for this row in the grid for this scene subplot .

    • column - If there is a layout grid, use the domain for this column in the grid for this scene subplot .


    plotly.graph_objs.layout.scene.XAxis([visible=], [showspikes=], [spikesides=], [spikethickness=], [spikecolor=], [showbackground=], [backgroundcolor=], [showaxeslabels=], [color=], [categoryorder=], [categoryarray=], [title=], [type=], [autotypenumbers=], [autorange=], [rangemode=], [range=], [tickmode=], [nticks=], [tick0=], [dtick=], [tickvals=], [ticktext=], [ticks=], [mirror=], [ticklen=], [tickwidth=], [tickcolor=], [showticklabels=], [tickfont=], [tickangle=], [tickprefix=], [showtickprefix=], [ticksuffix=], [showticksuffix=], [showexponent=], [exponentformat=], [minexponent=], [separatethousands=], [tickformat=], [tickformatstop=], [hoverformat=], [showline=], [linecolor=], [linewidth=], [showgrid=], [gridcolor=], [gridwidth=], [zeroline=], [zerolinecolor=], [zerolinewidth=], [_deprecated=], [calendar=], [categoryarraysrc=], [tickvalssrc=], [ticktextsrc=]) → XAxis

    Create a new ‘XAxis’ object

    • visible - 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

    • showspikes - Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

    • spikesides - Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

    • spikethickness - Sets the thickness (in px) of the spikes.

    • spikecolor - Sets the color of the spikes.

    • showbackground - Sets whether or not this axis' wall has a background color.

    • backgroundcolor - Sets the background color of this axis' wall.

    • showaxeslabels - Sets whether or not this axis is labeled

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

    • 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 - Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.

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

    • 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 - 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 - 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<f>* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick - 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<f>*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M<n>* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*

    • tickvals - Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.

    • ticktext - Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.

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

    • 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 - Sets the tick length (in px).

    • tickwidth - Sets the tick width (in px).

    • tickcolor - Sets the tick color.

    • showticklabels - Determines whether or not the tick labels are drawn.

    • tickfont - Sets the tick font.

    • tickangle - Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickprefix - Sets a tick label prefix.

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

    • ticksuffix - Sets a tick label suffix.

    • showticksuffix - Same as `showtickprefix` but for tick suffixes.

    • 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 - 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 - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

    • separatethousands - If "true", even 4-digit integers are separated

    • tickformat - 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 one item to d3's date formatter: *%{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*

    • hoverformat - 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 one item to d3's date formatter: *%{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 - Determines whether or not a line bounding this axis is drawn.

    • linecolor - Sets the axis line color.

    • linewidth - Sets the width (in px) of the axis line.

    • showgrid - Determines whether or not grid lines are drawn. If *true*, the grid lines are drawn at every tick mark.

    • gridcolor - Sets the color of the grid lines.

    • gridwidth - Sets the width (in px) of the grid lines.

    • zeroline - 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 - Sets the line color of the zero line.

    • zerolinewidth - Sets the width (in px) of the zero line.

    • 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`

    • categoryarraysrc - Sets the source reference on Chart Studio Cloud for categoryarray .

    • tickvalssrc - Sets the source reference on Chart Studio Cloud for tickvals .

    • ticktextsrc - Sets the source reference on Chart Studio Cloud for ticktext .


    plotly.graph_objs.layout.scene.YAxis([visible=], [showspikes=], [spikesides=], [spikethickness=], [spikecolor=], [showbackground=], [backgroundcolor=], [showaxeslabels=], [color=], [categoryorder=], [categoryarray=], [title=], [type=], [autotypenumbers=], [autorange=], [rangemode=], [range=], [tickmode=], [nticks=], [tick0=], [dtick=], [tickvals=], [ticktext=], [ticks=], [mirror=], [ticklen=], [tickwidth=], [tickcolor=], [showticklabels=], [tickfont=], [tickangle=], [tickprefix=], [showtickprefix=], [ticksuffix=], [showticksuffix=], [showexponent=], [exponentformat=], [minexponent=], [separatethousands=], [tickformat=], [tickformatstop=], [hoverformat=], [showline=], [linecolor=], [linewidth=], [showgrid=], [gridcolor=], [gridwidth=], [zeroline=], [zerolinecolor=], [zerolinewidth=], [_deprecated=], [calendar=], [categoryarraysrc=], [tickvalssrc=], [ticktextsrc=]) → YAxis

    Create a new ‘YAxis’ object

    • visible - 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

    • showspikes - Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

    • spikesides - Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

    • spikethickness - Sets the thickness (in px) of the spikes.

    • spikecolor - Sets the color of the spikes.

    • showbackground - Sets whether or not this axis' wall has a background color.

    • backgroundcolor - Sets the background color of this axis' wall.

    • showaxeslabels - Sets whether or not this axis is labeled

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

    • 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 - Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.

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

    • 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 - 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 - 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<f>* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick - 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<f>*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M<n>* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*

    • tickvals - Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.

    • ticktext - Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.

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

    • 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 - Sets the tick length (in px).

    • tickwidth - Sets the tick width (in px).

    • tickcolor - Sets the tick color.

    • showticklabels - Determines whether or not the tick labels are drawn.

    • tickfont - Sets the tick font.

    • tickangle - Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickprefix - Sets a tick label prefix.

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

    • ticksuffix - Sets a tick label suffix.

    • showticksuffix - Same as `showtickprefix` but for tick suffixes.

    • 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 - 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 - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

    • separatethousands - If "true", even 4-digit integers are separated

    • tickformat - 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 one item to d3's date formatter: *%{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*

    • hoverformat - 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 one item to d3's date formatter: *%{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 - Determines whether or not a line bounding this axis is drawn.

    • linecolor - Sets the axis line color.

    • linewidth - Sets the width (in px) of the axis line.

    • showgrid - Determines whether or not grid lines are drawn. If *true*, the grid lines are drawn at every tick mark.

    • gridcolor - Sets the color of the grid lines.

    • gridwidth - Sets the width (in px) of the grid lines.

    • zeroline - 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 - Sets the line color of the zero line.

    • zerolinewidth - Sets the width (in px) of the zero line.

    • 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`

    • categoryarraysrc - Sets the source reference on Chart Studio Cloud for categoryarray .

    • tickvalssrc - Sets the source reference on Chart Studio Cloud for tickvals .

    • ticktextsrc - Sets the source reference on Chart Studio Cloud for ticktext .


    plotly.graph_objs.layout.scene.ZAxis([visible=], [showspikes=], [spikesides=], [spikethickness=], [spikecolor=], [showbackground=], [backgroundcolor=], [showaxeslabels=], [color=], [categoryorder=], [categoryarray=], [title=], [type=], [autotypenumbers=], [autorange=], [rangemode=], [range=], [tickmode=], [nticks=], [tick0=], [dtick=], [tickvals=], [ticktext=], [ticks=], [mirror=], [ticklen=], [tickwidth=], [tickcolor=], [showticklabels=], [tickfont=], [tickangle=], [tickprefix=], [showtickprefix=], [ticksuffix=], [showticksuffix=], [showexponent=], [exponentformat=], [minexponent=], [separatethousands=], [tickformat=], [tickformatstop=], [hoverformat=], [showline=], [linecolor=], [linewidth=], [showgrid=], [gridcolor=], [gridwidth=], [zeroline=], [zerolinecolor=], [zerolinewidth=], [_deprecated=], [calendar=], [categoryarraysrc=], [tickvalssrc=], [ticktextsrc=]) → ZAxis

    Create a new ‘ZAxis’ object

    • visible - 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

    • showspikes - Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

    • spikesides - Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

    • spikethickness - Sets the thickness (in px) of the spikes.

    • spikecolor - Sets the color of the spikes.

    • showbackground - Sets whether or not this axis' wall has a background color.

    • backgroundcolor - Sets the background color of this axis' wall.

    • showaxeslabels - Sets whether or not this axis is labeled

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

    • 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 - Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.

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

    • 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 - 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 - 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<f>* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • dtick - 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<f>*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M<n>* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*

    • tickvals - Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.

    • ticktext - Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.

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

    • 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 - Sets the tick length (in px).

    • tickwidth - Sets the tick width (in px).

    • tickcolor - Sets the tick color.

    • showticklabels - Determines whether or not the tick labels are drawn.

    • tickfont - Sets the tick font.

    • tickangle - Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickprefix - Sets a tick label prefix.

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

    • ticksuffix - Sets a tick label suffix.

    • showticksuffix - Same as `showtickprefix` but for tick suffixes.

    • 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 - 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 - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

    • separatethousands - If "true", even 4-digit integers are separated

    • tickformat - 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 one item to d3's date formatter: *%{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*

    • hoverformat - 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 one item to d3's date formatter: *%{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 - Determines whether or not a line bounding this axis is drawn.

    • linecolor - Sets the axis line color.

    • linewidth - Sets the width (in px) of the axis line.

    • showgrid - Determines whether or not grid lines are drawn. If *true*, the grid lines are drawn at every tick mark.

    • gridcolor - Sets the color of the grid lines.

    • gridwidth - Sets the width (in px) of the grid lines.

    • zeroline - 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 - Sets the line color of the zero line.

    • zerolinewidth - Sets the width (in px) of the zero line.

    • 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`

    • categoryarraysrc - Sets the source reference on Chart Studio Cloud for categoryarray .

    • tickvalssrc - Sets the source reference on Chart Studio Cloud for tickvals .

    • ticktextsrc - Sets the source reference on Chart Studio Cloud for ticktext .


    Globals








    plotly.graph_objs.layout.scene