Live Chat

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

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

plotly.graph_objs.layout Module

Functions

plotly.graph_objs.layout.Activeshape([fillcolor=], [opacity=]) → Activeshape

Create a new ‘Activeshape’ object

  • fillcolor - Sets the color filling the active shape' interior.

  • opacity - Sets the opacity of the active shape.


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

Create a new ‘Annotation’ object

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

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

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

  • font - Sets the annotation text font.

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

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

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

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

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

  • bgcolor - Sets the background color of the annotation.

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

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

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

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

  • arrowcolor - Sets the color of the annotation arrow.

  • arrowhead - Sets the end annotation arrow head style.

  • startarrowhead - Sets the start annotation arrow head style.

  • arrowside - Sets the annotation arrow head position.

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

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

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

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

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

  • ax - Sets the x component of the arrow tail about the arrow head. If `axref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If `axref` is not `pixel` and is exactly the same as `xref`, this is an absolute value on that axis, like `x`, specified in the same coordinates as `xref`.

  • ay - Sets the y component of the arrow tail about the arrow head. If `ayref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If `ayref` is not `pixel` and is exactly the same as `yref`, this is an absolute value on that axis, like `y`, specified in the same coordinates as `yref`.

  • axref - Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a ax axis id (e.g. *ax* or *ax2*), the `ax` position refers to a ax coordinate. If set to *paper*, the `ax` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a ax axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *ax2 domain* refers to the domain of the second ax axis and a ax position of 0.5 refers to the point between the left and the right of the domain of the second ax axis. In order for absolute positioning of the arrow to work, *axref* must be exactly the same as *xref*, otherwise *axref* will revert to *pixel* (explained next). For relative positioning, *axref* can be set to *pixel*, in which case the *ax* value is specified in pixels relative to *x*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

  • ayref - Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a ay axis id (e.g. *ay* or *ay2*), the `ay` position refers to a ay coordinate. If set to *paper*, the `ay` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a ay axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *ay2 domain* refers to the domain of the second ay axis and a ay position of 0.5 refers to the point between the bottom and the top of the domain of the second ay axis. In order for absolute positioning of the arrow to work, *ayref* must be exactly the same as *yref*, otherwise *ayref* will revert to *pixel* (explained next). For relative positioning, *ayref* can be set to *pixel*, in which case the *ay* value is specified in pixels relative to *y*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

  • xref - Sets the annotation's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

  • x - Sets the annotation's x position. If the axis `type` is *log*, then you must take the log of your desired range. 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.

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

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

  • yref - Sets the annotation's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

  • y - Sets the annotation's y position. If the axis `type` is *log*, then you must take the log of your desired range. 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.

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

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

  • clicktoshow - Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the `x` and `y` values of this annotation, and it is hidden (visible: false), it will appear. In *onoff* mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In *onout* mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different `x` or `y` values, you can set `xclick` and/or `yclick`. This is useful for example to label the side of a bar. To label markers though, `standoff` is preferred over `xclick` and `yclick`.

  • xclick - Toggle this annotation when clicking a data point whose `x` value is `xclick` rather than the annotation's `x` value.

  • yclick - Toggle this annotation when clicking a data point whose `y` value is `yclick` rather than the annotation's `y` value.

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

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

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

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


plotly.graph_objs.layout.Coloraxis([cauto=], [cmin=], [cmax=], [cmid=], [colorscale=], [autocolorscale=], [reversescale=], [showscale=], [colorbar=]) → Coloraxis

Create a new ‘Coloraxis’ object

  • cauto - Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

  • cmin - Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmax` must be set as well.

  • cmax - Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmin` must be set as well.

  • cmid - Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect when `cauto` is `false`.

  • colorscale - Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

  • autocolorscale - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

  • reversescale - Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

  • showscale - Determines whether or not a colorbar is displayed for this trace.


plotly.graph_objs.layout.Colorscale([sequential=], [sequentialminus=], [diverging=]) → Colorscale

Create a new ‘Colorscale’ object

  • sequential - Sets the default sequential colorscale for positive values. Note that `autocolorscale` must be true for this attribute to work.

  • sequentialminus - Sets the default sequential colorscale for negative values. Note that `autocolorscale` must be true for this attribute to work.

  • diverging - Sets the default diverging colorscale. Note that `autocolorscale` must be true for this attribute to work.


plotly.graph_objs.layout.Font([family=], [size=], [color=]) → Font

Create a new ‘Font’ object

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


plotly.graph_objs.layout.Geo([domain=], [fitbounds=], [resolution=], [scope=], [projection=], [center=], [visible=], [showcoastlines=], [coastlinecolor=], [coastlinewidth=], [showland=], [landcolor=], [showocean=], [oceancolor=], [showlakes=], [lakecolor=], [showrivers=], [rivercolor=], [riverwidth=], [showcountries=], [countrycolor=], [countrywidth=], [showsubunits=], [subunitcolor=], [subunitwidth=], [showframe=], [framecolor=], [framewidth=], [bgcolor=], [lonaxis=], [lataxis=], [uirevision=]) → Geo

Create a new ‘Geo’ object

  • fitbounds - Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting `fitbounds` leads to `center.lon` and `center.lat` getting auto-filled. On maps with a non-clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, and `projection.rotation.lon` getting auto-filled. On maps with a clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, `projection.rotation.lon`, `projection.rotation.lat`, `lonaxis.range` and `lonaxis.range` getting auto-filled. If *locations*, only the trace's visible locations are considered in the `fitbounds` computations. If *geojson*, the entire trace input `geojson` (if provided) is considered in the `fitbounds` computations, Defaults to *false*.

  • resolution - Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

  • scope - Set the scope of the map.

  • visible - Sets the default visibility of the base layers.

  • showcoastlines - Sets whether or not the coastlines are drawn.

  • coastlinecolor - Sets the coastline color.

  • coastlinewidth - Sets the coastline stroke width (in px).

  • showland - Sets whether or not land masses are filled in color.

  • landcolor - Sets the land mass color.

  • showocean - Sets whether or not oceans are filled in color.

  • oceancolor - Sets the ocean color

  • showlakes - Sets whether or not lakes are drawn.

  • lakecolor - Sets the color of the lakes.

  • showrivers - Sets whether or not rivers are drawn.

  • rivercolor - Sets color of the rivers.

  • riverwidth - Sets the stroke width (in px) of the rivers.

  • showcountries - Sets whether or not country boundaries are drawn.

  • countrycolor - Sets line color of the country boundaries.

  • countrywidth - Sets line width (in px) of the country boundaries.

  • showsubunits - Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.

  • subunitcolor - Sets the color of the subunits boundaries.

  • subunitwidth - Sets the stroke width (in px) of the subunits boundaries.

  • showframe - Sets whether or not a frame is drawn around the map.

  • framecolor - Sets the color the frame.

  • framewidth - Sets the stroke width (in px) of the frame.

  • bgcolor - Set the background color of the map

  • uirevision - Controls persistence of user-driven changes in the view (projection and center). Defaults to `layout.uirevision`.


plotly.graph_objs.layout.Grid([rows=], [roworder=], [columns=], [subplots=], [xaxes=], [yaxes=], [pattern=], [xgap=], [ygap=], [domain=], [xside=], [yside=]) → Grid

Create a new ‘Grid’ object

  • rows - The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

  • roworder - Is the first row the top or the bottom? Note that columns are always enumerated from left to right.

  • columns - The number of columns in the grid. If you provide a 2D `subplots` array, the length of its longest row is used as the default. If you give an `xaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

  • subplots - Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like *xy* or *x3y2*, or ** to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute.

  • xaxes - Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like *x*, *x2*, etc., or ** to not put an x axis in that column. Entries other than ** must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs.

  • yaxes - Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like *y*, *y2*, etc., or ** to not put a y axis in that row. Entries other than ** must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs.

  • pattern - If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults using consecutive axis IDs, in two ways: *coupled* gives one x axis per column and one y axis per row. *independent* uses a new xy pair for each cell, left-to-right across each row then iterating rows according to `roworder`.

  • xgap - Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.

  • ygap - Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.

  • xside - Sets where the x axis labels and titles go. *bottom* means the very bottom of the grid. *bottom plot* is the lowest plot that each x axis is used in. *top* and *top plot* are similar.

  • yside - Sets where the y axis labels and titles go. *left* means the very left edge of the grid. *left plot* is the leftmost plot that each y axis is used in. *right* and *right plot* are similar.


plotly.graph_objs.layout.Hoverlabel([bgcolor=], [bordercolor=], [font=], [align=], [namelength=]) → Hoverlabel

Create a new ‘Hoverlabel’ object

  • bgcolor - Sets the background color of all hover labels on graph

  • bordercolor - Sets the border color of all hover labels on graph.

  • font - Sets the default hover label font used by all traces on the graph.

  • align - Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

  • namelength - Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.


plotly.graph_objs.layout.Image([visible=], [source=], [layer=], [sizex=], [sizey=], [sizing=], [opacity=], [x=], [y=], [xanchor=], [yanchor=], [xref=], [yref=], [name=], [templateitemname=]) → Image

Create a new ‘Image’ object

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

  • source - Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute.

  • layer - Specifies whether images are drawn below or above traces. When `xref` and `yref` are both set to `paper`, image is drawn below the entire plot area.

  • sizex - Sets the image container size horizontally. The image will be sized based on the `position` value. When `xref` is set to `paper`, units are sized relative to the plot width. When `xref` ends with ` domain`, units are sized relative to the axis width.

  • sizey - Sets the image container size vertically. The image will be sized based on the `position` value. When `yref` is set to `paper`, units are sized relative to the plot height. When `yref` ends with ` domain`, units are sized relative to the axis height.

  • sizing - Specifies which dimension of the image to constrain.

  • opacity - Sets the opacity of the image.

  • x - Sets the image's x position. When `xref` is set to `paper`, units are sized relative to the plot height. See `xref` for more info

  • y - Sets the image's y position. When `yref` is set to `paper`, units are sized relative to the plot height. See `yref` for more info

  • xanchor - Sets the anchor for the x position

  • yanchor - Sets the anchor for the y position.

  • xref - Sets the images's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

  • yref - Sets the images's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

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

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


plotly.graph_objs.layout.Legend([bgcolor=], [bordercolor=], [borderwidth=], [font=], [orientation=], [traceorder=], [tracegroupgap=], [itemsizing=], [itemwidth=], [itemclick=], [itemdoubleclick=], [x=], [xanchor=], [y=], [yanchor=], [uirevision=], [valign=], [title=]) → Legend

Create a new ‘Legend’ object

  • bgcolor - Sets the legend background color. Defaults to `layout.paper_bgcolor`.

  • bordercolor - Sets the color of the border enclosing the legend.

  • borderwidth - Sets the width (in px) of the border enclosing the legend.

  • font - Sets the font used to text the legend items.

  • orientation - Sets the orientation of the legend.

  • traceorder - Determines the order at which the legend items are displayed. If *normal*, the items are displayed top-to-bottom in the same order as the input data. If *reversed*, the items are displayed in the opposite order as *normal*. If *grouped*, the items are displayed in groups (when a trace `legendgroup` is provided). if *grouped+reversed*, the items are displayed in the opposite order as *grouped*.

  • tracegroupgap - Sets the amount of vertical space (in px) between legend groups.

  • itemsizing - Determines if the legend items symbols scale with their corresponding *trace* attributes or remain *constant* independent of the symbol size on the graph.

  • itemwidth - Sets the width (in px) of the legend item symbols (the part other than the title.text).

  • itemclick - Determines the behavior on legend item click. *toggle* toggles the visibility of the item clicked on the graph. *toggleothers* makes the clicked item the sole visible item on the graph. *false* disable legend item click interactions.

  • itemdoubleclick - Determines the behavior on legend item double-click. *toggle* toggles the visibility of the item clicked on the graph. *toggleothers* makes the clicked item the sole visible item on the graph. *false* disable legend item double-click interactions.

  • x - Sets the x position (in normalized coordinates) of the legend. Defaults to *1.02* for vertical legends and defaults to *0* for horizontal legends.

  • xanchor - Sets the legend's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the legend. Value *auto* anchors legends to the right for `x` values greater than or equal to 2/3, anchors legends to the left for `x` values less than or equal to 1/3 and anchors legends with respect to their center otherwise.

  • y - Sets the y position (in normalized coordinates) of the legend. Defaults to *1* for vertical legends, defaults to *-0.1* for horizontal legends on graphs w/o range sliders and defaults to *1.1* for horizontal legends on graph with one or multiple range sliders.

  • yanchor - Sets the legend's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the legend. Value *auto* anchors legends at their bottom for `y` values less than or equal to 1/3, anchors legends to at their top for `y` values greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.

  • uirevision - Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to `layout.uirevision`.

  • valign - Sets the vertical alignment of the symbols with respect to their associated text.


plotly.graph_objs.layout.Mapbox([domain=], [accesstoken=], [style=], [center=], [zoom=], [bearing=], [pitch=], [layer=], [uirevision=]) → Mapbox

Create a new ‘Mapbox’ object

  • accesstoken - Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under `mapboxAccessToken`. Note that accessToken are only required when `style` (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.

  • style - Defines the map layers that are rendered by default below the trace layers defined in `data`, which are themselves by default rendered below the layers defined in `layout.mapbox.layers`. These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the `accesstoken` attribute or in the `mapboxAccessToken` config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: open-street-map, white-bg, carto-positron, carto-darkmatter, stamen-terrain, stamen-toner, stamen-watercolor The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox-<name>-<version>

  • zoom - Sets the zoom level of the map (mapbox.zoom).

  • bearing - Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).

  • pitch - Sets the pitch angle of the map (in degrees, where *0* means perpendicular to the surface of the map) (mapbox.pitch).

  • uirevision - Controls persistence of user-driven changes in the view: `center`, `zoom`, `bearing`, `pitch`. Defaults to `layout.uirevision`.


plotly.graph_objs.layout.Margin([l=], [r=], [t=], [b=], [pad=], [autoexpand=]) → Margin

Create a new ‘Margin’ object

  • l - Sets the left margin (in px).

  • r - Sets the right margin (in px).

  • t - Sets the top margin (in px).

  • b - Sets the bottom margin (in px).

  • pad - Sets the amount of padding (in px) between the plotting area and the axis lines

  • autoexpand - Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults.


plotly.graph_objs.layout.Modebar([orientation=], [bgcolor=], [color=], [activecolor=], [uirevision=]) → Modebar

Create a new ‘Modebar’ object

  • orientation - Sets the orientation of the modebar.

  • bgcolor - Sets the background color of the modebar.

  • color - Sets the color of the icons in the modebar.

  • activecolor - Sets the color of the active or hovered on icons in the modebar.

  • uirevision - Controls persistence of user-driven changes related to the modebar, including `hovermode`, `dragmode`, and `showspikes` at both the root level and inside subplots. Defaults to `layout.uirevision`.


plotly.graph_objs.layout.Newshape([line=], [fillcolor=], [fillrule=], [opacity=], [layer=], [drawdirection=]) → Newshape

Create a new ‘Newshape’ object

  • fillcolor - Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.

  • fillrule - Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule

  • opacity - Sets the opacity of new shapes.

  • layer - Specifies whether new shapes are drawn below or above traces.

  • drawdirection - When `dragmode` is set to *drawrect*, *drawline* or *drawcircle* this limits the drag to be horizontal, vertical or diagonal. Using *diagonal* there is no limit e.g. in drawing lines in any direction. *ortho* limits the draw to be either horizontal or vertical. *horizontal* allows horizontal extend. *vertical* allows vertical extend.


plotly.graph_objs.layout.Polar([domain=], [sector=], [hole=], [bgcolor=], [radialaxis=], [angularaxis=], [gridshape=], [uirevision=]) → Polar

Create a new ‘Polar’ object

  • sector - Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with *0* corresponding to rightmost limit of the polar subplot.

  • hole - Sets the fraction of the radius to cut out of the polar subplot.

  • bgcolor - Set the background color of the subplot

  • gridshape - Determines if the radial axis grid lines and angular axis line are drawn as *circular* sectors or as *linear* (polygon) sectors. Has an effect only when the angular axis has `type` *category*. Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is *circular* (so that radial axis scale is the same as the data scale).

  • uirevision - Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.


plotly.graph_objs.layout.Scene([bgcolor=], [camera=], [domain=], [aspectmode=], [aspectratio=], [xaxis=], [yaxis=], [zaxis=], [dragmode=], [hovermode=], [uirevision=], [_deprecated=], [annotation=]) → Scene

Create a new ‘Scene’ object

  • aspectmode - If *cube*, this scene's axes are drawn as a cube, regardless of the axes' ranges. If *data*, this scene's axes are drawn in proportion with the axes' ranges. If *manual*, this scene's axes are drawn in proportion with the input of *aspectratio* (the default behavior if *aspectratio* is provided). If *auto*, this scene's axes are drawn using the results of *data* except when one axis is more than four times the size of the two others, where in that case the results of *cube* are used.

  • aspectratio - Sets this scene's axis aspectratio.

  • dragmode - Determines the mode of drag interactions for this scene.

  • hovermode - Determines the mode of hover interactions for this scene.

  • uirevision - Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`.


plotly.graph_objs.layout.Shape([visible=], [type=], [layer=], [xref=], [xsizemode=], [xanchor=], [x0=], [x1=], [yref=], [ysizemode=], [yanchor=], [y0=], [y1=], [path=], [opacity=], [line=], [fillcolor=], [fillrule=], [editable=], [name=], [templateitemname=]) → Shape

Create a new ‘Shape’ object

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

  • type - Specifies the shape type to be drawn. If *line*, a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect to the axes' sizing mode. If *circle*, a circle is drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes' sizing mode. If *rect*, a rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to the axes' sizing mode. If *path*, draw a custom SVG path using `path`. with respect to the axes' sizing mode.

  • layer - Specifies whether shapes are drawn below or above traces.

  • xref - Sets the shape's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. If the axis `type` is *log*, then you must take the log of your desired range. If the axis `type` is *date*, then you must convert the date to unix time in milliseconds.

  • xsizemode - Sets the shapes's sizing mode along the x axis. If set to *scaled*, `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to *paper*). If set to *pixel*, `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.

  • xanchor - Only relevant in conjunction with `xsizemode` set to *pixel*. Specifies the anchor point on the x axis to which `x0`, `x1` and x coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `xsizemode` not set to *pixel*.

  • x0 - Sets the shape's starting x position. See `type` and `xsizemode` for more info.

  • x1 - Sets the shape's end x position. See `type` and `xsizemode` for more info.

  • yref - Sets the annotation's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

  • ysizemode - Sets the shapes's sizing mode along the y axis. If set to *scaled*, `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to *paper*). If set to *pixel*, `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.

  • yanchor - Only relevant in conjunction with `ysizemode` set to *pixel*. Specifies the anchor point on the y axis to which `y0`, `y1` and y coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `ysizemode` not set to *pixel*.

  • y0 - Sets the shape's starting y position. See `type` and `ysizemode` for more info.

  • y1 - Sets the shape's end y position. See `type` and `ysizemode` for more info.

  • path - For `type` *path* - a valid SVG path with the pixel values replaced by data values in `xsizemode`/`ysizemode` being *scaled* and taken unmodified as pixels relative to `xanchor` and `yanchor` in case of *pixel* size mode. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained "polybezier" commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can't use either to separate date from time parts. Therefore we'll use underscore for this purpose: 2015-02-21_13:45:56.789

  • opacity - Sets the opacity of the shape.

  • fillcolor - Sets the color filling the shape's interior. Only applies to closed shapes.

  • fillrule - Determines which regions of complex paths constitute the interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule

  • editable - Determines whether the shape could be activated for edit or not. Has no effect when the older editable shapes mode is enabled via `config.editable` or `config.edits.shapePosition`.

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

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


plotly.graph_objs.layout.Slider([visible=], [active=], [step=], [lenmode=], [len=], [x=], [pad=], [xanchor=], [y=], [yanchor=], [transition=], [currentvalue=], [font=], [activebgcolor=], [bgcolor=], [bordercolor=], [borderwidth=], [ticklen=], [tickcolor=], [tickwidth=], [minorticklen=], [name=], [templateitemname=]) → Slider

Create a new ‘Slider’ object

  • visible - Determines whether or not the slider is visible.

  • active - Determines which button (by index starting from 0) is considered active.

  • lenmode - Determines whether this slider length is set in units of plot *fraction* or in *pixels. Use `len` to set the value.

  • len - Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends.

  • x - Sets the x position (in normalized coordinates) of the slider.

  • pad - Set the padding of the slider component along each side.

  • xanchor - Sets the slider's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the range selector.

  • y - Sets the y position (in normalized coordinates) of the slider.

  • yanchor - Sets the slider's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the range selector.

  • font - Sets the font of the slider step labels.

  • activebgcolor - Sets the background color of the slider grip while dragging.

  • bgcolor - Sets the background color of the slider.

  • bordercolor - Sets the color of the border enclosing the slider.

  • borderwidth - Sets the width (in px) of the border enclosing the slider.

  • ticklen - Sets the length in pixels of step tick marks

  • tickcolor - Sets the color of the border enclosing the slider.

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

  • minorticklen - Sets the length in pixels of minor step tick marks

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

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


plotly.graph_objs.layout.Ternary([domain=], [bgcolor=], [sum=], [aaxis=], [baxis=], [caxis=], [uirevision=]) → Ternary

Create a new ‘Ternary’ object

  • bgcolor - Set the background color of the subplot

  • sum - The number each triplet should sum to, and the maximum range of each axis

  • uirevision - Controls persistence of user-driven changes in axis `min` and `title`, if not overridden in the individual axes. Defaults to `layout.uirevision`.


plotly.graph_objs.layout.Title([text=], [font=], [xref=], [yref=], [x=], [y=], [xanchor=], [yanchor=], [pad=]) → Title

Create a new ‘Title’ object

  • text - Sets the plot's title. 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.

  • font - Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

  • xref - Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.

  • yref - Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.

  • x - Sets the x position with respect to `xref` in normalized coordinates from *0* (left) to *1* (right).

  • y - Sets the y position with respect to `yref` in normalized coordinates from *0* (bottom) to *1* (top). *auto* places the baseline of the title onto the vertical center of the top margin.

  • xanchor - Sets the title's horizontal alignment with respect to its x position. *left* means that the title starts at x, *right* means that the title ends at x and *center* means that the title's center is at x. *auto* divides `xref` by three and calculates the `xanchor` value automatically based on the value of `x`.

  • yanchor - Sets the title's vertical alignment with respect to its y position. *top* means that the title's cap line is at y, *bottom* means that the title's baseline is at y and *middle* means that the title's midline is at y. *auto* divides `yref` by three and calculates the `yanchor` value automatically based on the value of `y`.

  • pad - Sets the padding of the title. Each padding value only applies when the corresponding `xanchor`/`yanchor` value is set accordingly. E.g. for left padding to take effect, `xanchor` must be set to *left*. The same rule applies if `xanchor`/`yanchor` is determined automatically. Padding is muted if the respective anchor value is *middle*/*center*.


plotly.graph_objs.layout.Transition([duration=], [easing=], [ordering=]) → Transition

Create a new ‘Transition’ object

  • duration - The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.

  • easing - The easing function used for the transition

  • ordering - Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change.


plotly.graph_objs.layout.Uniformtext([mode=], [minsize=]) → Uniformtext

Create a new ‘Uniformtext’ object

  • mode - Determines how the font size for various text elements are uniformed between each trace type. If the computed text sizes were smaller than the minimum size defined by `uniformtext.minsize` using *hide* option hides the text; and using *show* option shows the text without further downscaling. Please note that if the size defined by `minsize` is greater than the font size defined by trace, then the `minsize` is used.

  • minsize - Sets the minimum text size between traces of the same type.


plotly.graph_objs.layout.Updatemenu([visible=], [type=], [direction=], [active=], [showactive=], [button=], [x=], [xanchor=], [y=], [yanchor=], [pad=], [font=], [bgcolor=], [bordercolor=], [borderwidth=], [name=], [templateitemname=]) → Updatemenu

Create a new ‘Updatemenu’ object

  • visible - Determines whether or not the update menu is visible.

  • type - Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically

  • direction - Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For `left` and `up`, the buttons will still appear in left-to-right or top-to-bottom order respectively.

  • active - Determines which button (by index starting from 0) is considered active.

  • showactive - Highlights active dropdown item or active button if true.

  • x - Sets the x position (in normalized coordinates) of the update menu.

  • xanchor - Sets the update menu's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the range selector.

  • y - Sets the y position (in normalized coordinates) of the update menu.

  • yanchor - Sets the update menu's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the range selector.

  • pad - Sets the padding around the buttons or dropdown menu.

  • font - Sets the font of the update menu button text.

  • bgcolor - Sets the background color of the update menu buttons.

  • bordercolor - Sets the color of the border enclosing the update menu.

  • borderwidth - Sets the width (in px) of the border enclosing the update menu.

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

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


plotly.graph_objs.layout.XAxis([visible=], [color=], [title=], [type=], [autotypenumbers=], [autorange=], [rangemode=], [range=], [fixedrange=], [scaleanchor=], [scaleratio=], [constrain=], [constraintoward=], [matches=], [rangebreak=], [tickmode=], [nticks=], [tick0=], [dtick=], [tickvals=], [ticktext=], [ticks=], [tickson=], [ticklabelmode=], [ticklabelposition=], [mirror=], [ticklen=], [tickwidth=], [tickcolor=], [showticklabels=], [automargin=], [showspikes=], [spikecolor=], [spikethickness=], [spikedash=], [spikemode=], [spikesnap=], [tickfont=], [tickangle=], [tickprefix=], [showtickprefix=], [ticksuffix=], [showticksuffix=], [showexponent=], [exponentformat=], [minexponent=], [separatethousands=], [tickformat=], [tickformatstop=], [hoverformat=], [showline=], [linecolor=], [linewidth=], [showgrid=], [gridcolor=], [gridwidth=], [zeroline=], [zerolinecolor=], [zerolinewidth=], [showdividers=], [dividercolor=], [dividerwidth=], [anchor=], [side=], [overlaying=], [layer=], [domain=], [position=], [categoryorder=], [categoryarray=], [uirevision=], [_deprecated=], [rangeslider=], [rangeselector=], [calendar=], [tickvalssrc=], [ticktextsrc=], [categoryarraysrc=]) → XAxis

Create a new ‘XAxis’ object

  • visible - A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false

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

  • type - Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

  • autotypenumbers - Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.

  • autorange - Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to *false*.

  • rangemode - If *normal*, the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If *nonnegative*, the range is non-negative, regardless of the input data. Applies only to linear axes.

  • range - Sets the range of this axis. If the axis `type` is *log*, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is *date*, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is *category*, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

  • fixedrange - Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

  • scaleanchor - If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden.

  • scaleratio - If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

  • constrain - If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the *range*, or by decreasing the *domain*. Default is *domain* for axes containing image traces, *range* otherwise.

  • constraintoward - If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are *left*, *center* (default), and *right* for x axes, and *top*, *middle* (default), and *bottom* for y axes.

  • matches - If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.

  • tickmode - Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).

  • nticks - Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.

  • tick0 - Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L<f>* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

  • dtick - Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L<f>*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M<n>* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*

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

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

  • ticks - Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.

  • tickson - Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` *category* or *multicategory*. When set to *boundaries*, ticks and grid lines are drawn half a category to the left/bottom of labels.

  • ticklabelmode - Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` *date* When set to *period*, tick labels are drawn in the middle of the period between ticks.

  • ticklabelposition - Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when `ticklabelmode` is set to *period*. Similarly left or right has no effect on y axes or when `ticklabelmode` is set to *period*. Has no effect on *multicategory* axes or when `tickson` is set to *boundaries*. When used on axes linked by `matches` or `scaleanchor`, no extra padding for inside labels would be added by autorange, so that the scales could match.

  • mirror - Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If *true*, the axis lines are mirrored. If *ticks*, the axis lines and ticks are mirrored. If *false*, mirroring is disable. If *all*, axis lines are mirrored on all shared-axes subplots. If *allticks*, axis lines and ticks are mirrored on all shared-axes subplots.

  • ticklen - Sets the tick length (in px).

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

  • tickcolor - Sets the tick color.

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

  • automargin - Determines whether long tick labels automatically grow the figure margins.

  • showspikes - Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

  • spikecolor - Sets the spike color. If undefined, will use the series color

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

  • spikedash - Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).

  • spikemode - Determines the drawing mode for the spike line If *toaxis*, the line is drawn from the data point to the axis the series is plotted on. If *across*, the line is drawn across the entire plot area, and supercedes *toaxis*. If *marker*, then a marker dot is drawn on the axis the series is plotted on

  • spikesnap - Determines whether spikelines are stuck to the cursor or to the closest datapoints.

  • tickfont - Sets the tick font.

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

  • tickprefix - Sets a tick label prefix.

  • showtickprefix - If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.

  • ticksuffix - Sets a tick label suffix.

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

  • showexponent - If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.

  • exponentformat - Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.

  • minexponent - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

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

  • tickformat - Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*

  • hoverformat - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*

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

  • linecolor - Sets the axis line color.

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

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

  • gridcolor - Sets the color of the grid lines.

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

  • zeroline - Determines whether or not a line is drawn at along the 0 value of this axis. If *true*, the zero line is drawn on top of the grid lines.

  • zerolinecolor - Sets the line color of the zero line.

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

  • showdividers - Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on *multicategory* axes.

  • dividercolor - Sets the color of the dividers Only has an effect on *multicategory* axes.

  • dividerwidth - Sets the width (in px) of the dividers Only has an effect on *multicategory* axes.

  • anchor - If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to *free*, this axis' position is determined by `position`.

  • side - Determines whether a x (y) axis is positioned at the *bottom* (*left*) or *top* (*right*) of the plotting area.

  • overlaying - If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If *false*, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

  • layer - Sets the layer on which this axis is displayed. If *above traces*, this axis is displayed above all the subplot's traces If *below traces*, this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to *false* to show markers and/or text nodes above this axis.

  • domain - Sets the domain of this axis (in plot fraction).

  • position - Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to *free*.

  • categoryorder - Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

  • categoryarray - Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.

  • uirevision - Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`.

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

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

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

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


plotly.graph_objs.layout.YAxis([visible=], [color=], [title=], [type=], [autotypenumbers=], [autorange=], [rangemode=], [range=], [fixedrange=], [scaleanchor=], [scaleratio=], [constrain=], [constraintoward=], [matches=], [rangebreak=], [tickmode=], [nticks=], [tick0=], [dtick=], [tickvals=], [ticktext=], [ticks=], [tickson=], [ticklabelmode=], [ticklabelposition=], [mirror=], [ticklen=], [tickwidth=], [tickcolor=], [showticklabels=], [automargin=], [showspikes=], [spikecolor=], [spikethickness=], [spikedash=], [spikemode=], [spikesnap=], [tickfont=], [tickangle=], [tickprefix=], [showtickprefix=], [ticksuffix=], [showticksuffix=], [showexponent=], [exponentformat=], [minexponent=], [separatethousands=], [tickformat=], [tickformatstop=], [hoverformat=], [showline=], [linecolor=], [linewidth=], [showgrid=], [gridcolor=], [gridwidth=], [zeroline=], [zerolinecolor=], [zerolinewidth=], [showdividers=], [dividercolor=], [dividerwidth=], [anchor=], [side=], [overlaying=], [layer=], [domain=], [position=], [categoryorder=], [categoryarray=], [uirevision=], [_deprecated=], [calendar=], [tickvalssrc=], [ticktextsrc=], [categoryarraysrc=]) → YAxis

Create a new ‘YAxis’ object

  • visible - A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false

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

  • type - Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

  • autotypenumbers - Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.

  • autorange - Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to *false*.

  • rangemode - If *normal*, the range is computed in relation to the extrema of the input data. If *tozero*`, the range extends to 0, regardless of the input data If *nonnegative*, the range is non-negative, regardless of the input data. Applies only to linear axes.

  • range - Sets the range of this axis. If the axis `type` is *log*, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is *date*, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is *category*, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

  • fixedrange - Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

  • scaleanchor - If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden.

  • scaleratio - If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

  • constrain - If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the *range*, or by decreasing the *domain*. Default is *domain* for axes containing image traces, *range* otherwise.

  • constraintoward - If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are *left*, *center* (default), and *right* for x axes, and *top*, *middle* (default), and *bottom* for y axes.

  • matches - If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.

  • tickmode - Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).

  • nticks - Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.

  • tick0 - Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L<f>* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

  • dtick - Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L<f>*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M<n>* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*

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

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

  • ticks - Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.

  • tickson - Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` *category* or *multicategory*. When set to *boundaries*, ticks and grid lines are drawn half a category to the left/bottom of labels.

  • ticklabelmode - Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` *date* When set to *period*, tick labels are drawn in the middle of the period between ticks.

  • ticklabelposition - Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when `ticklabelmode` is set to *period*. Similarly left or right has no effect on y axes or when `ticklabelmode` is set to *period*. Has no effect on *multicategory* axes or when `tickson` is set to *boundaries*. When used on axes linked by `matches` or `scaleanchor`, no extra padding for inside labels would be added by autorange, so that the scales could match.

  • mirror - Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If *true*, the axis lines are mirrored. If *ticks*, the axis lines and ticks are mirrored. If *false*, mirroring is disable. If *all*, axis lines are mirrored on all shared-axes subplots. If *allticks*, axis lines and ticks are mirrored on all shared-axes subplots.

  • ticklen - Sets the tick length (in px).

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

  • tickcolor - Sets the tick color.

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

  • automargin - Determines whether long tick labels automatically grow the figure margins.

  • showspikes - Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

  • spikecolor - Sets the spike color. If undefined, will use the series color

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

  • spikedash - Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).

  • spikemode - Determines the drawing mode for the spike line If *toaxis*, the line is drawn from the data point to the axis the series is plotted on. If *across*, the line is drawn across the entire plot area, and supercedes *toaxis*. If *marker*, then a marker dot is drawn on the axis the series is plotted on

  • spikesnap - Determines whether spikelines are stuck to the cursor or to the closest datapoints.

  • tickfont - Sets the tick font.

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

  • tickprefix - Sets a tick label prefix.

  • showtickprefix - If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.

  • ticksuffix - Sets a tick label suffix.

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

  • showexponent - If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.

  • exponentformat - Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.

  • minexponent - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

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

  • tickformat - Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*

  • hoverformat - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*

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

  • linecolor - Sets the axis line color.

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

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

  • gridcolor - Sets the color of the grid lines.

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

  • zeroline - Determines whether or not a line is drawn at along the 0 value of this axis. If *true*, the zero line is drawn on top of the grid lines.

  • zerolinecolor - Sets the line color of the zero line.

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

  • showdividers - Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on *multicategory* axes.

  • dividercolor - Sets the color of the dividers Only has an effect on *multicategory* axes.

  • dividerwidth - Sets the width (in px) of the dividers Only has an effect on *multicategory* axes.

  • anchor - If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to *free*, this axis' position is determined by `position`.

  • side - Determines whether a x (y) axis is positioned at the *bottom* (*left*) or *top* (*right*) of the plotting area.

  • overlaying - If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If *false*, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

  • layer - Sets the layer on which this axis is displayed. If *above traces*, this axis is displayed above all the subplot's traces If *below traces*, this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to *false* to show markers and/or text nodes above this axis.

  • domain - Sets the domain of this axis (in plot fraction).

  • position - Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to *free*.

  • categoryorder - Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

  • categoryarray - Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.

  • uirevision - Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`.

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

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

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

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


Globals



















plotly.graph_objs.layout