plotly.graph_objects.layout.scene package

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

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property 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 HTML tags) or if an explicit width is set to override the text width.

The ‘align’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘left’, ‘center’, ‘right’]

Returns
Return type: Any

property arrowcolor¶

Sets the color of the annotation arrow.

The ‘arrowcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property arrowhead¶

Sets the end annotation arrow head style.

The ‘arrowhead’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 8]

Returns
Return type: int

property arrowside¶

Sets the annotation arrow head position.

The ‘arrowside’ property is a flaglist and may be specified as a string containing:

Any combination of [‘end’, ‘start’] joined with ‘+’ characters (e.g. ‘end+start’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns
Return type: Any

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

The ‘arrowsize’ property is a number and may be specified as:

An int or float in the interval [0.3, inf]

Returns
Return type: int|float

property arrowwidth¶

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

The ‘arrowwidth’ property is a number and may be specified as:

An int or float in the interval [0.1, inf]

Returns
Return type: int|float

property ax¶

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

The ‘ax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property ay¶

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

The ‘ay’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property bgcolor¶

Sets the background color of the annotation.

The ‘bgcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property bordercolor¶

Sets the color of the border enclosing the annotation text.

The ‘bordercolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property borderpad¶

Sets the padding (in px) between the text and the enclosing border.

The ‘borderpad’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property borderwidth¶

Sets the width (in px) of the border enclosing the annotation text.

The ‘borderwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘captureevents’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property font¶

Sets the annotation text font.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.layout.scene.annotation.Font

A dict of string/value properties that will be passed to the Font constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Returns
Return type: plotly.graph_objects.layout.scene.annotation.Font

property height¶

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

The ‘height’ property is a number and may be specified as:

An int or float in the interval [1, inf]

Returns
Return type: int|float

property hoverlabel¶

The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:

An instance of plotly.graph_objects.layout.scene.annotation.Hoverlabel

A dict of string/value properties that will be passed to the Hoverlabel constructor

Supported dict properties:

bgcolor
Sets the background color of the hover label. By default uses the annotation’s bgcolor made opaque, or white if it was transparent.

bordercolor
Sets the border color of the hover label. By default uses either dark grey or white, for maximum contrast with hoverlabel.bgcolor.

font
Sets the hover label text font. By default uses the global hover font and size, with color from hoverlabel.bordercolor.

Returns
Return type: plotly.graph_objects.layout.scene.annotation.Hoverlabel

property hovertext¶

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

The ‘hovertext’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

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

The ‘name’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property opacity¶

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

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

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

The ‘showarrow’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘standoff’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property startarrowhead¶

Sets the start annotation arrow head style.

The ‘startarrowhead’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 8]

Returns
Return type: int

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

The ‘startarrowsize’ property is a number and may be specified as:

An int or float in the interval [0.3, inf]

Returns
Return type: int|float

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

The ‘startstandoff’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘templateitemname’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property text¶

Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline ( ), bold (), italics (), hyperlinks (<a href=’…’></a>). Tags , , are also supported.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property textangle¶

Sets the angle at which the text is drawn with respect to the horizontal.

The ‘textangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns
Return type: int|float

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

The ‘valign’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘top’, ‘middle’, ‘bottom’]

Returns
Return type: Any

property visible¶

Determines whether or not this annotation is visible.

The ‘visible’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property 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 to start a new line.

The ‘width’ property is a number and may be specified as:

An int or float in the interval [1, inf]

Returns
Return type: int|float

property x¶

Sets the annotation’s x position.

The ‘x’ property accepts values of any type

Returns
Return type: Any

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

The ‘xanchor’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘auto’, ‘left’, ‘center’, ‘right’]

Returns
Return type: Any

property xshift¶

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

The ‘xshift’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property y¶

Sets the annotation’s y position.

The ‘y’ property accepts values of any type

Returns
Return type: Any

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

The ‘yanchor’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘auto’, ‘top’, ‘middle’, ‘bottom’]

Returns
Return type: Any

property yshift¶

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

The ‘yshift’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property z¶

Sets the annotation’s z position.

The ‘z’ property accepts values of any type

Returns
Return type: Any

class plotly.graph_objects.layout.scene.Aspectratio(arg=None, x=None, y=None, z=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property x¶

The ‘x’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property y¶

The ‘y’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property z¶

The ‘z’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

class plotly.graph_objects.layout.scene.Camera(arg=None, center=None, eye=None, projection=None, up=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

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

The ‘center’ property is an instance of Center that may be specified as:

An instance of plotly.graph_objects.layout.scene.camera.Center

A dict of string/value properties that will be passed to the Center constructor

Supported dict properties:

x

y

z

Returns
Return type: plotly.graph_objects.layout.scene.camera.Center

property eye¶

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

The ‘eye’ property is an instance of Eye that may be specified as:

An instance of plotly.graph_objects.layout.scene.camera.Eye

A dict of string/value properties that will be passed to the Eye constructor

Supported dict properties:

x

y

z

Returns
Return type: plotly.graph_objects.layout.scene.camera.Eye

property projection¶

The ‘projection’ property is an instance of Projection that may be specified as:

An instance of plotly.graph_objects.layout.scene.camera.Projection

A dict of string/value properties that will be passed to the Projection constructor

Supported dict properties:

type
Sets the projection type. The projection type could be either “perspective” or “orthographic”. The default is “perspective”.

Returns
Return type: plotly.graph_objects.layout.scene.camera.Projection

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

The ‘up’ property is an instance of Up that may be specified as:

An instance of plotly.graph_objects.layout.scene.camera.Up

A dict of string/value properties that will be passed to the Up constructor

Supported dict properties:

x

y

z

Returns
Return type: plotly.graph_objects.layout.scene.camera.Up

class plotly.graph_objects.layout.scene.Domain(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property column¶

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

The ‘column’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property row¶

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

The ‘row’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property x¶

Sets the horizontal domain of this scene subplot (in plot

fraction).

The ‘x’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘x[0]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
The ‘x[1]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
list

property y¶

Sets the vertical domain of this scene subplot (in plot

fraction).

The ‘y’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘y[0]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
The ‘y[1]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
list

class plotly.graph_objects.layout.scene.XAxis(arg=None, autorange=None, autorangeoptions=None, autotypenumbers=None, backgroundcolor=None, calendar=None, categoryarray=None, categoryarraysrc=None, categoryorder=None, color=None, dtick=None, exponentformat=None, gridcolor=None, gridwidth=None, hoverformat=None, labelalias=None, linecolor=None, linewidth=None, maxallowed=None, minallowed=None, minexponent=None, mirror=None, nticks=None, range=None, rangemode=None, separatethousands=None, showaxeslabels=None, showbackground=None, showexponent=None, showgrid=None, showline=None, showspikes=None, showticklabels=None, showtickprefix=None, showticksuffix=None, spikecolor=None, spikesides=None, spikethickness=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, ticksuffix=None, ticktext=None, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, titlefont=None, type=None, visible=None, zeroline=None, zerolinecolor=None, zerolinewidth=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property 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 and it has a value for both the lower and upper bound, autorange is set to False. Using “min” applies autorange only to set the minimum. Using “max” applies autorange only to set the maximum. Using min reversed applies autorange only to set the minimum on a reversed axis. Using max reversed applies autorange only to set the maximum on a reversed axis. Using “reversed” applies autorange on both ends and reverses the axis direction.

The ‘autorange’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘reversed’, ‘min reversed’, ‘max reversed’, ‘min’, ‘max’]

Returns
Return type: Any

property autorangeoptions¶

The ‘autorangeoptions’ property is an instance of Autorangeoptions that may be specified as:

An instance of plotly.graph_objects.layout.scene.xaxis.Autorangeoptions

A dict of string/value properties that will be passed to the Autorangeoptions constructor

Supported dict properties:

clipmax
Clip autorange maximum if it goes beyond this value. Has no effect when autorangeoptions.maxallowed is provided.

clipmin
Clip autorange minimum if it goes beyond this value. Has no effect when autorangeoptions.minallowed is provided.

include
Ensure this value is included in autorange.

includesrc
Sets the source reference on Chart Studio Cloud for include.

maxallowed
Use this value exactly as autorange maximum.

minallowed
Use this value exactly as autorange minimum.

Returns
Return type: plotly.graph_objects.layout.scene.xaxis.Autorangeoptions

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

The ‘autotypenumbers’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘convert types’, ‘strict’]

Returns
Return type: Any

property backgroundcolor¶

Sets the background color of this axis’ wall.

The ‘backgroundcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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

The ‘calendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property categoryarray¶

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

The ‘categoryarray’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property categoryarraysrc¶

Sets the source reference on Chart Studio Cloud for categoryarray.

The ‘categoryarraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

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

The ‘categoryorder’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘trace’, ‘category ascending’, ‘category descending’, ‘array’, ‘total ascending’, ‘total descending’, ‘min ascending’, ‘min descending’, ‘max ascending’, ‘max descending’, ‘sum ascending’, ‘sum descending’, ‘mean ascending’, ‘mean descending’, ‘median ascending’, ‘median descending’]

Returns
Return type: Any

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

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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”

The ‘dtick’ property accepts values of any type

Returns
Return type: Any

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

The ‘exponentformat’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’]

Returns
Return type: Any

property gridcolor¶

Sets the color of the grid lines.

The ‘gridcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property gridwidth¶

Sets the width (in px) of the grid lines.

The ‘gridwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

The ‘hoverformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property labelalias¶

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. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html- like tags or MathJax.

The ‘labelalias’ property accepts values of any type

Returns
Return type: Any

property linecolor¶

Sets the axis line color.

The ‘linecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property linewidth¶

Sets the width (in px) of the axis line.

The ‘linewidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property maxallowed¶

Determines the maximum range of this axis.

The ‘maxallowed’ property accepts values of any type

Returns
Return type: Any

property minallowed¶

Determines the minimum range of this axis.

The ‘minallowed’ property accepts values of any type

Returns
Return type: Any

property minexponent¶

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is “SI” or “B”.

The ‘minexponent’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘mirror’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, ‘ticks’, False, ‘all’, ‘allticks’]

Returns
Return type: Any

property 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”.

The ‘nticks’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property 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. Leaving either or both elements null impacts the default autorange.

The ‘range’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type

list

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

The ‘rangemode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘tozero’, ‘nonnegative’]

Returns
Return type: Any

property separatethousands¶

If “true”, even 4-digit integers are separated

The ‘separatethousands’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showaxeslabels¶

Sets whether or not this axis is labeled

The ‘showaxeslabels’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showbackground¶

Sets whether or not this axis’ wall has a background color.

The ‘showbackground’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘showexponent’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showgrid¶

Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.

The ‘showgrid’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showline¶

Determines whether or not a line bounding this axis is drawn.

The ‘showline’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showspikes¶

Sets whether or not spikes starting from data points to this axis’ wall are shown on hover.

The ‘showspikes’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showticklabels¶

Determines whether or not the tick labels are drawn.

The ‘showticklabels’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘showtickprefix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showticksuffix¶

Same as showtickprefix but for tick suffixes.

The ‘showticksuffix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property spikecolor¶

Sets the color of the spikes.

The ‘spikecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property spikesides¶

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

The ‘spikesides’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property spikethickness¶

Sets the thickness (in px) of the spikes.

The ‘spikethickness’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘tick0’ property accepts values of any type

Returns
Return type: Any

property tickangle¶

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

The ‘tickangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns
Return type: int|float

property tickcolor¶

Sets the tick color.

The ‘tickcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property tickfont¶

Sets the tick font.

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

An instance of plotly.graph_objects.layout.scene.xaxis.Tickfont

A dict of string/value properties that will be passed to the Tickfont constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Returns
Return type: plotly.graph_objects.layout.scene.xaxis.Tickfont

property 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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

The ‘tickformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property tickformatstopdefaults¶

When used in a template (as layout.template.layout.scene.xaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.scene.xaxis.tickformatstops

The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:

An instance of plotly.graph_objects.layout.scene.xaxis.Tickformatstop

A dict of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

Returns
Return type: plotly.graph_objects.layout.scene.xaxis.Tickformatstop

property tickformatstops¶

The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:

A list or tuple of instances of plotly.graph_objects.layout.scene.xaxis.Tickformatstop

A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

dtickrange
range [min, max], where “min”, “max” - dtick values which describe some zoom level, it is possible to omit “min” or “max” value by passing “null”

enabled
Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.

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.

value
string - dtickformat for described zoom level, the same as “tickformat”

Returns
Return type: tuple[plotly.graph_objects.layout.scene.xaxis.Tickformatstop]

property ticklen¶

Sets the tick length (in px).

The ‘ticklen’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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).

The ‘tickmode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘auto’, ‘linear’, ‘array’]

Returns
Return type: Any

property tickprefix¶

Sets a tick label prefix.

The ‘tickprefix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

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

The ‘ticks’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘outside’, ‘inside’, ‘’]

Returns
Return type: Any

property ticksuffix¶

Sets a tick label suffix.

The ‘ticksuffix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticktext¶

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property ticktextsrc¶

Sets the source reference on Chart Studio Cloud for ticktext.

The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property tickvals¶

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property tickvalssrc¶

Sets the source reference on Chart Studio Cloud for tickvals.

The ‘tickvalssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property tickwidth¶

Sets the tick width (in px).

The ‘tickwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property title¶

The ‘title’ property is an instance of Title that may be specified as:

An instance of plotly.graph_objects.layout.scene.xaxis.Title

A dict of string/value properties that will be passed to the Title constructor

Supported dict properties:

font
Sets this axis’ title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

text
Sets the title of this axis. Note that before the existence of title.text, the title’s contents used to be defined as the title attribute itself. This behavior has been deprecated.

Returns
Return type: plotly.graph_objects.layout.scene.xaxis.Title

property titlefont¶

Please use layout.scene.xaxis.title.font instead. Sets this axis’ title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.layout.scene.xaxis.title.Font

A dict of string/value properties that will be passed to the Font constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Type: Deprecated

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

The ‘type’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘-‘, ‘linear’, ‘log’, ‘date’, ‘category’]

Returns
Return type: Any

property 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

The ‘visible’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘zeroline’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property zerolinecolor¶

Sets the line color of the zero line.

The ‘zerolinecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property zerolinewidth¶

Sets the width (in px) of the zero line.

The ‘zerolinewidth’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

class plotly.graph_objects.layout.scene.YAxis(arg=None, autorange=None, autorangeoptions=None, autotypenumbers=None, backgroundcolor=None, calendar=None, categoryarray=None, categoryarraysrc=None, categoryorder=None, color=None, dtick=None, exponentformat=None, gridcolor=None, gridwidth=None, hoverformat=None, labelalias=None, linecolor=None, linewidth=None, maxallowed=None, minallowed=None, minexponent=None, mirror=None, nticks=None, range=None, rangemode=None, separatethousands=None, showaxeslabels=None, showbackground=None, showexponent=None, showgrid=None, showline=None, showspikes=None, showticklabels=None, showtickprefix=None, showticksuffix=None, spikecolor=None, spikesides=None, spikethickness=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, ticksuffix=None, ticktext=None, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, titlefont=None, type=None, visible=None, zeroline=None, zerolinecolor=None, zerolinewidth=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property 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 and it has a value for both the lower and upper bound, autorange is set to False. Using “min” applies autorange only to set the minimum. Using “max” applies autorange only to set the maximum. Using min reversed applies autorange only to set the minimum on a reversed axis. Using max reversed applies autorange only to set the maximum on a reversed axis. Using “reversed” applies autorange on both ends and reverses the axis direction.

The ‘autorange’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘reversed’, ‘min reversed’, ‘max reversed’, ‘min’, ‘max’]

Returns
Return type: Any

property autorangeoptions¶

The ‘autorangeoptions’ property is an instance of Autorangeoptions that may be specified as:

An instance of plotly.graph_objects.layout.scene.yaxis.Autorangeoptions

A dict of string/value properties that will be passed to the Autorangeoptions constructor

Supported dict properties:

clipmax
Clip autorange maximum if it goes beyond this value. Has no effect when autorangeoptions.maxallowed is provided.

clipmin
Clip autorange minimum if it goes beyond this value. Has no effect when autorangeoptions.minallowed is provided.

include
Ensure this value is included in autorange.

includesrc
Sets the source reference on Chart Studio Cloud for include.

maxallowed
Use this value exactly as autorange maximum.

minallowed
Use this value exactly as autorange minimum.

Returns
Return type: plotly.graph_objects.layout.scene.yaxis.Autorangeoptions

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

The ‘autotypenumbers’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘convert types’, ‘strict’]

Returns
Return type: Any

property backgroundcolor¶

Sets the background color of this axis’ wall.

The ‘backgroundcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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

The ‘calendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property categoryarray¶

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

The ‘categoryarray’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property categoryarraysrc¶

Sets the source reference on Chart Studio Cloud for categoryarray.

The ‘categoryarraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

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

The ‘categoryorder’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘trace’, ‘category ascending’, ‘category descending’, ‘array’, ‘total ascending’, ‘total descending’, ‘min ascending’, ‘min descending’, ‘max ascending’, ‘max descending’, ‘sum ascending’, ‘sum descending’, ‘mean ascending’, ‘mean descending’, ‘median ascending’, ‘median descending’]

Returns
Return type: Any

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

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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”

The ‘dtick’ property accepts values of any type

Returns
Return type: Any

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

The ‘exponentformat’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’]

Returns
Return type: Any

property gridcolor¶

Sets the color of the grid lines.

The ‘gridcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property gridwidth¶

Sets the width (in px) of the grid lines.

The ‘gridwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

The ‘hoverformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property labelalias¶

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. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html- like tags or MathJax.

The ‘labelalias’ property accepts values of any type

Returns
Return type: Any

property linecolor¶

Sets the axis line color.

The ‘linecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property linewidth¶

Sets the width (in px) of the axis line.

The ‘linewidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property maxallowed¶

Determines the maximum range of this axis.

The ‘maxallowed’ property accepts values of any type

Returns
Return type: Any

property minallowed¶

Determines the minimum range of this axis.

The ‘minallowed’ property accepts values of any type

Returns
Return type: Any

property minexponent¶

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is “SI” or “B”.

The ‘minexponent’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘mirror’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, ‘ticks’, False, ‘all’, ‘allticks’]

Returns
Return type: Any

property 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”.

The ‘nticks’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property 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. Leaving either or both elements null impacts the default autorange.

The ‘range’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type

list

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

The ‘rangemode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘tozero’, ‘nonnegative’]

Returns
Return type: Any

property separatethousands¶

If “true”, even 4-digit integers are separated

The ‘separatethousands’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showaxeslabels¶

Sets whether or not this axis is labeled

The ‘showaxeslabels’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showbackground¶

Sets whether or not this axis’ wall has a background color.

The ‘showbackground’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘showexponent’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showgrid¶

Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.

The ‘showgrid’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showline¶

Determines whether or not a line bounding this axis is drawn.

The ‘showline’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showspikes¶

Sets whether or not spikes starting from data points to this axis’ wall are shown on hover.

The ‘showspikes’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showticklabels¶

Determines whether or not the tick labels are drawn.

The ‘showticklabels’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘showtickprefix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showticksuffix¶

Same as showtickprefix but for tick suffixes.

The ‘showticksuffix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property spikecolor¶

Sets the color of the spikes.

The ‘spikecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property spikesides¶

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

The ‘spikesides’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property spikethickness¶

Sets the thickness (in px) of the spikes.

The ‘spikethickness’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘tick0’ property accepts values of any type

Returns
Return type: Any

property tickangle¶

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

The ‘tickangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns
Return type: int|float

property tickcolor¶

Sets the tick color.

The ‘tickcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property tickfont¶

Sets the tick font.

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

An instance of plotly.graph_objects.layout.scene.yaxis.Tickfont

A dict of string/value properties that will be passed to the Tickfont constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Returns
Return type: plotly.graph_objects.layout.scene.yaxis.Tickfont

property 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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

The ‘tickformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property tickformatstopdefaults¶

When used in a template (as layout.template.layout.scene.yaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.scene.yaxis.tickformatstops

The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:

An instance of plotly.graph_objects.layout.scene.yaxis.Tickformatstop

A dict of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

Returns
Return type: plotly.graph_objects.layout.scene.yaxis.Tickformatstop

property tickformatstops¶

The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:

A list or tuple of instances of plotly.graph_objects.layout.scene.yaxis.Tickformatstop

A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

dtickrange
range [min, max], where “min”, “max” - dtick values which describe some zoom level, it is possible to omit “min” or “max” value by passing “null”

enabled
Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.

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.

value
string - dtickformat for described zoom level, the same as “tickformat”

Returns
Return type: tuple[plotly.graph_objects.layout.scene.yaxis.Tickformatstop]

property ticklen¶

Sets the tick length (in px).

The ‘ticklen’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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).

The ‘tickmode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘auto’, ‘linear’, ‘array’]

Returns
Return type: Any

property tickprefix¶

Sets a tick label prefix.

The ‘tickprefix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

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

The ‘ticks’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘outside’, ‘inside’, ‘’]

Returns
Return type: Any

property ticksuffix¶

Sets a tick label suffix.

The ‘ticksuffix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticktext¶

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property ticktextsrc¶

Sets the source reference on Chart Studio Cloud for ticktext.

The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property tickvals¶

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property tickvalssrc¶

Sets the source reference on Chart Studio Cloud for tickvals.

The ‘tickvalssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property tickwidth¶

Sets the tick width (in px).

The ‘tickwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property title¶

The ‘title’ property is an instance of Title that may be specified as:

An instance of plotly.graph_objects.layout.scene.yaxis.Title

A dict of string/value properties that will be passed to the Title constructor

Supported dict properties:

font
Sets this axis’ title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

text
Sets the title of this axis. Note that before the existence of title.text, the title’s contents used to be defined as the title attribute itself. This behavior has been deprecated.

Returns
Return type: plotly.graph_objects.layout.scene.yaxis.Title

property titlefont¶

Please use layout.scene.yaxis.title.font instead. Sets this axis’ title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.layout.scene.yaxis.title.Font

A dict of string/value properties that will be passed to the Font constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Type: Deprecated

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

The ‘type’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘-‘, ‘linear’, ‘log’, ‘date’, ‘category’]

Returns
Return type: Any

property 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

The ‘visible’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘zeroline’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property zerolinecolor¶

Sets the line color of the zero line.

The ‘zerolinecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property zerolinewidth¶

Sets the width (in px) of the zero line.

The ‘zerolinewidth’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

class plotly.graph_objects.layout.scene.ZAxis(arg=None, autorange=None, autorangeoptions=None, autotypenumbers=None, backgroundcolor=None, calendar=None, categoryarray=None, categoryarraysrc=None, categoryorder=None, color=None, dtick=None, exponentformat=None, gridcolor=None, gridwidth=None, hoverformat=None, labelalias=None, linecolor=None, linewidth=None, maxallowed=None, minallowed=None, minexponent=None, mirror=None, nticks=None, range=None, rangemode=None, separatethousands=None, showaxeslabels=None, showbackground=None, showexponent=None, showgrid=None, showline=None, showspikes=None, showticklabels=None, showtickprefix=None, showticksuffix=None, spikecolor=None, spikesides=None, spikethickness=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, ticksuffix=None, ticktext=None, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, titlefont=None, type=None, visible=None, zeroline=None, zerolinecolor=None, zerolinewidth=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property 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 and it has a value for both the lower and upper bound, autorange is set to False. Using “min” applies autorange only to set the minimum. Using “max” applies autorange only to set the maximum. Using min reversed applies autorange only to set the minimum on a reversed axis. Using max reversed applies autorange only to set the maximum on a reversed axis. Using “reversed” applies autorange on both ends and reverses the axis direction.

The ‘autorange’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, False, ‘reversed’, ‘min reversed’, ‘max reversed’, ‘min’, ‘max’]

Returns
Return type: Any

property autorangeoptions¶

The ‘autorangeoptions’ property is an instance of Autorangeoptions that may be specified as:

An instance of plotly.graph_objects.layout.scene.zaxis.Autorangeoptions

A dict of string/value properties that will be passed to the Autorangeoptions constructor

Supported dict properties:

clipmax
Clip autorange maximum if it goes beyond this value. Has no effect when autorangeoptions.maxallowed is provided.

clipmin
Clip autorange minimum if it goes beyond this value. Has no effect when autorangeoptions.minallowed is provided.

include
Ensure this value is included in autorange.

includesrc
Sets the source reference on Chart Studio Cloud for include.

maxallowed
Use this value exactly as autorange maximum.

minallowed
Use this value exactly as autorange minimum.

Returns
Return type: plotly.graph_objects.layout.scene.zaxis.Autorangeoptions

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

The ‘autotypenumbers’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘convert types’, ‘strict’]

Returns
Return type: Any

property backgroundcolor¶

Sets the background color of this axis’ wall.

The ‘backgroundcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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

The ‘calendar’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]

Returns
Return type: Any

property categoryarray¶

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

The ‘categoryarray’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property categoryarraysrc¶

Sets the source reference on Chart Studio Cloud for categoryarray.

The ‘categoryarraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

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

The ‘categoryorder’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘trace’, ‘category ascending’, ‘category descending’, ‘array’, ‘total ascending’, ‘total descending’, ‘min ascending’, ‘min descending’, ‘max ascending’, ‘max descending’, ‘sum ascending’, ‘sum descending’, ‘mean ascending’, ‘mean descending’, ‘median ascending’, ‘median descending’]

Returns
Return type: Any

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

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property 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”

The ‘dtick’ property accepts values of any type

Returns
Return type: Any

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

The ‘exponentformat’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’]

Returns
Return type: Any

property gridcolor¶

Sets the color of the grid lines.

The ‘gridcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property gridwidth¶

Sets the width (in px) of the grid lines.

The ‘gridwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

The ‘hoverformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property labelalias¶

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. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html- like tags or MathJax.

The ‘labelalias’ property accepts values of any type

Returns
Return type: Any

property linecolor¶

Sets the axis line color.

The ‘linecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property linewidth¶

Sets the width (in px) of the axis line.

The ‘linewidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property maxallowed¶

Determines the maximum range of this axis.

The ‘maxallowed’ property accepts values of any type

Returns
Return type: Any

property minallowed¶

Determines the minimum range of this axis.

The ‘minallowed’ property accepts values of any type

Returns
Return type: Any

property minexponent¶

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is “SI” or “B”.

The ‘minexponent’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘mirror’ property is an enumeration that may be specified as:

One of the following enumeration values:
[True, ‘ticks’, False, ‘all’, ‘allticks’]

Returns
Return type: Any

property 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”.

The ‘nticks’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property 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. Leaving either or both elements null impacts the default autorange.

The ‘range’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘range[0]’ property accepts values of any type
The ‘range[1]’ property accepts values of any type

list

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

The ‘rangemode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘tozero’, ‘nonnegative’]

Returns
Return type: Any

property separatethousands¶

If “true”, even 4-digit integers are separated

The ‘separatethousands’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showaxeslabels¶

Sets whether or not this axis is labeled

The ‘showaxeslabels’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showbackground¶

Sets whether or not this axis’ wall has a background color.

The ‘showbackground’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘showexponent’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showgrid¶

Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark.

The ‘showgrid’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showline¶

Determines whether or not a line bounding this axis is drawn.

The ‘showline’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showspikes¶

Sets whether or not spikes starting from data points to this axis’ wall are shown on hover.

The ‘showspikes’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showticklabels¶

Determines whether or not the tick labels are drawn.

The ‘showticklabels’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘showtickprefix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property showticksuffix¶

Same as showtickprefix but for tick suffixes.

The ‘showticksuffix’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]

Returns
Return type: Any

property spikecolor¶

Sets the color of the spikes.

The ‘spikecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property spikesides¶

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

The ‘spikesides’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property spikethickness¶

Sets the thickness (in px) of the spikes.

The ‘spikethickness’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

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

The ‘tick0’ property accepts values of any type

Returns
Return type: Any

property tickangle¶

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

The ‘tickangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns
Return type: int|float

property tickcolor¶

Sets the tick color.

The ‘tickcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property tickfont¶

Sets the tick font.

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

An instance of plotly.graph_objects.layout.scene.zaxis.Tickfont

A dict of string/value properties that will be passed to the Tickfont constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Returns
Return type: plotly.graph_objects.layout.scene.zaxis.Tickfont

property 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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

The ‘tickformat’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property tickformatstopdefaults¶

When used in a template (as layout.template.layout.scene.zaxis.tickformatstopdefaults), sets the default property values to use for elements of layout.scene.zaxis.tickformatstops

The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:

An instance of plotly.graph_objects.layout.scene.zaxis.Tickformatstop

A dict of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

Returns
Return type: plotly.graph_objects.layout.scene.zaxis.Tickformatstop

property tickformatstops¶

The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:

A list or tuple of instances of plotly.graph_objects.layout.scene.zaxis.Tickformatstop

A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

dtickrange
range [min, max], where “min”, “max” - dtick values which describe some zoom level, it is possible to omit “min” or “max” value by passing “null”

enabled
Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.

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.

value
string - dtickformat for described zoom level, the same as “tickformat”

Returns
Return type: tuple[plotly.graph_objects.layout.scene.zaxis.Tickformatstop]

property ticklen¶

Sets the tick length (in px).

The ‘ticklen’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property 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).

The ‘tickmode’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘auto’, ‘linear’, ‘array’]

Returns
Return type: Any

property tickprefix¶

Sets a tick label prefix.

The ‘tickprefix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

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

The ‘ticks’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘outside’, ‘inside’, ‘’]

Returns
Return type: Any

property ticksuffix¶

Sets a tick label suffix.

The ‘ticksuffix’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticktext¶

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property ticktextsrc¶

Sets the source reference on Chart Studio Cloud for ticktext.

The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property tickvals¶

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property tickvalssrc¶

Sets the source reference on Chart Studio Cloud for tickvals.

The ‘tickvalssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property tickwidth¶

Sets the tick width (in px).

The ‘tickwidth’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

property title¶

The ‘title’ property is an instance of Title that may be specified as:

An instance of plotly.graph_objects.layout.scene.zaxis.Title

A dict of string/value properties that will be passed to the Title constructor

Supported dict properties:

font
Sets this axis’ title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

text
Sets the title of this axis. Note that before the existence of title.text, the title’s contents used to be defined as the title attribute itself. This behavior has been deprecated.

Returns
Return type: plotly.graph_objects.layout.scene.zaxis.Title

property titlefont¶

Please use layout.scene.zaxis.title.font instead. Sets this axis’ title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.layout.scene.zaxis.title.Font

A dict of string/value properties that will be passed to the Font constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

size

Type: Deprecated

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

The ‘type’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘-‘, ‘linear’, ‘log’, ‘date’, ‘category’]

Returns
Return type: Any

property 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

The ‘visible’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

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

The ‘zeroline’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property zerolinecolor¶

Sets the line color of the zero line.

The ‘zerolinecolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property zerolinewidth¶

Sets the width (in px) of the zero line.

The ‘zerolinewidth’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

plotly.graph_objects.layout.scene package¶

Subpackages¶