plotly.graph_objects.Layout¶

class plotly.graph_objects.Layout(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickanywhere=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hoveranywhere=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversort=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, margin=None, meta=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)¶

__init__(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickanywhere=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hoveranywhere=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversort=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, margin=None, meta=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)¶

Construct a new Layout object

Parameters

• arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Layout

• activeselection – plotly.graph_objects.layout.Activeselection instance or dict with compatible properties

• activeshape – plotly.graph_objects.layout.Activeshape instance or dict with compatible properties

• annotations – A tuple of plotly.graph_objects.layout.Annotation instances or dicts with compatible properties

• annotationdefaults – When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations

• autosize – Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

• 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. This is the default value; however it could be overridden for individual axes.

• barcornerradius – Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).

• bargap – Sets the gap (in plot fraction) between bars of adjacent location coordinates.

• bargroupgap – Sets the gap (in plot fraction) between bars of the same location coordinate.

• barmode – Determines how bars at the same location coordinate are displayed on the graph. With “stack”, the bars are stacked on top of one another With “relative”, the bars are stacked on top of one another, with negative values below the axis, positive values above With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

• barnorm – Sets the normalization for bar traces on the graph. With “fraction”, the value of each bar is divided by the sum of all values at that location coordinate. “percent” is the same but multiplied by 100 to show percentages.

• boxgap – Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have “width” set.

• boxgroupgap – Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have “width” set.

• boxmode – Determines how boxes at the same location coordinate are displayed on the graph. If “group”, the boxes are plotted next to one another centered around the shared location. If “overlay”, the boxes are plotted over one another, you might need to set “opacity” to see them multiple boxes. Has no effect on traces that have “width” set.

• calendar – Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

• clickanywhere – If true, plotly_click events will fire for any click position within the plot area, not just over traces. When clicking where there is no trace data, the event will have an empty points array but will include xvals and yvals with click coordinates in data space, and xPixel and yPixel with click coordinates in pixels, relative to the top-left corner of the graph div.

• clickmode – Determines the mode of single click interactions. “event” is the default value and emits the plotly_click event. In addition this mode emits the plotly_selected event in drag modes “lasso” and “select”, but with no event data attached (kept for compatibility reasons). The “select” flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. “select” with hovermode: “x” can be confusing, consider explicitly setting hovermode: “closest” when using this feature. Selection events are sent accordingly as long as “event” flag is set as well. When the “event” flag is missing, plotly_click and plotly_selected events are not fired.

• coloraxis – plotly.graph_objects.layout.Coloraxis instance or dict with compatible properties

• colorscale – plotly.graph_objects.layout.Colorscale instance or dict with compatible properties

• colorway – Sets the default trace colors.

• computed – Placeholder for exporting automargin-impacting values namely margin.t, margin.b, margin.l and margin.r in “full-json” mode.

• datarevision – If provided, a changed value tells Plotly.react that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, Plotly.react assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

• dragmode – Determines the mode of drag interactions. “select” and “lasso” apply only to scatter traces with markers or text. “orbit” and “turntable” apply only to 3D scenes.

• editrevision – Controls persistence of user-driven changes in editable: true configuration, other than trace names and axis titles. Defaults to layout.uirevision.

• extendfunnelareacolors – If true, the funnelarea slice colors (whether given by funnelareacolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

• extendiciclecolors – If true, the icicle slice colors (whether given by iciclecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

• extendpiecolors – If true, the pie slice colors (whether given by piecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

• extendsunburstcolors – If true, the sunburst slice colors (whether given by sunburstcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

• extendtreemapcolors – If true, the treemap slice colors (whether given by treemapcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

• font – Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.

• funnelareacolorway – Sets the default funnelarea slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendfunnelareacolors.

• funnelgap – Sets the gap (in plot fraction) between bars of adjacent location coordinates.

• funnelgroupgap – Sets the gap (in plot fraction) between bars of the same location coordinate.

• funnelmode – Determines how bars at the same location coordinate are displayed on the graph. With “stack”, the bars are stacked on top of one another With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

• geo – plotly.graph_objects.layout.Geo instance or dict with compatible properties

• grid – plotly.graph_objects.layout.Grid instance or dict with compatible properties

• height – Sets the plot’s height (in px).

• hiddenlabels – hiddenlabels is the funnelarea & pie chart analog of visible:’legendonly’ but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts

• hoveranywhere – If true, plotly_hover events will fire for any cursor position within the plot area, not just over traces. When the cursor is not over a trace, the event will have an empty points array but will include xvals and yvals with cursor coordinates in data space, and xPixel and yPixel with cursor coordinates in pixels, relative to the top-left corner of the graph div. A plotly_unhover event fires when the cursor leaves the plot area.

• hoverdistance – Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.

• hoverlabel – plotly.graph_objects.layout.Hoverlabel instance or dict with compatible properties

• hovermode – Determines the mode of hover interactions. If “closest”, a single hoverlabel will appear for the “closest” point within the hoverdistance. If “x” (or “y”), multiple hoverlabels will appear for multiple points at the “closest” x- (or y-) coordinate within the hoverdistance, with the caveat that no more than one hoverlabel will appear per trace. If x unified (or y unified), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the hoverdistance with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled.

• hoversort – Determines the order of items shown in unified hover labels. If “trace”, items are sorted by trace index. If value descending, items are sorted by value from largest to smallest. If value ascending, items are sorted by value from smallest to largest. Only applies when hovermode is x unified or y unified.

• hoversubplots – Determines expansion of hover effects to other subplots If “single” just the axis pair of the primary point is included without overlaying subplots. If “overlaying” all subplots using the main axis and occupying the same space are included. If “axis”, also include stacked subplots using the same axis when hovermode is set to “x”, x unified, “y” or y unified.

• iciclecolorway – Sets the default icicle slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendiciclecolors.

• images – A tuple of plotly.graph_objects.layout.Image instances or dicts with compatible properties

• imagedefaults – When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images

• legend – plotly.graph_objects.layout.Legend instance or dict with compatible properties

• map – plotly.graph_objects.layout.Map instance or dict with compatible properties

• margin – plotly.graph_objects.layout.Margin instance or dict with compatible properties

• meta – Assigns extra meta information that can be used in various text attributes. Attributes such as the graph, axis and colorbar title.text, annotation text trace.name in legend items, rangeselector, updatemenus and sliders label text all support meta. One can access meta fields using template strings: %{meta[i]} where i is the index of the meta item in question. meta can also be an object for example {key: value} which can be accessed %{meta[key]}.

• minreducedheight – Minimum height of the plot with margin.automargin applied (in px)

• minreducedwidth – Minimum width of the plot with margin.automargin applied (in px)

• modebar – plotly.graph_objects.layout.Modebar instance or dict with compatible properties

• newselection – plotly.graph_objects.layout.Newselection instance or dict with compatible properties

• newshape – plotly.graph_objects.layout.Newshape instance or dict with compatible properties

• paper_bgcolor – Sets the background color of the paper where the graph is drawn.

• piecolorway – Sets the default pie slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendpiecolors.

• plot_bgcolor – Sets the background color of the plotting area in- between x and y axes.

• polar – plotly.graph_objects.layout.Polar instance or dict with compatible properties

• scattergap – Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to bargap.

• scattermode – Determines how scatter points at the same location coordinate are displayed on the graph. With “group”, the scatter points are plotted next to one another centered around the shared location. With “overlay”, the scatter points are plotted over one another, you might need to reduce “opacity” to see multiple scatter points.

• scene – plotly.graph_objects.layout.Scene instance or dict with compatible properties

• selectdirection – When dragmode is set to “select”, this limits the selection of the drag to horizontal, vertical or diagonal. “h” only allows horizontal selection, “v” only vertical, “d” only diagonal and “any” sets no limit.

• selectionrevision – Controls persistence of user-driven changes in selected points from all traces.

• selections – A tuple of plotly.graph_objects.layout.Selection instances or dicts with compatible properties

• selectiondefaults – When used in a template (as layout.template.layout.selectiondefaults), sets the default property values to use for elements of layout.selections

• separators – Sets the decimal and thousand separators. For example, *. * puts a ‘.’ before decimals and a space between thousands. In English locales, dflt is “.,” but other locales may alter this default.

• shapes – A tuple of plotly.graph_objects.layout.Shape instances or dicts with compatible properties

• shapedefaults – When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes

• showlegend – Determines whether or not a legend is drawn. Default is true if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with showlegend: true.

• sliders – A tuple of plotly.graph_objects.layout.Slider instances or dicts with compatible properties

• sliderdefaults – When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders

• smith – plotly.graph_objects.layout.Smith instance or dict with compatible properties

• spikedistance – Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

• sunburstcolorway – Sets the default sunburst slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendsunburstcolors.

• template – Default attributes to be applied to the plot. This should be a dict with format: {'layout': layoutTemplate, 'data': {trace_type: [traceTemplate, ...], ...}} where layoutTemplate is a dict matching the structure of figure.layout and traceTemplate is a dict matching the structure of the trace with type trace_type (e.g. ‘scatter’). Alternatively, this may be specified as an instance of plotly.graph_objects.layout.Template. Trace templates are applied cyclically to traces of each type. Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so this can be used to add a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false.

• ternary – plotly.graph_objects.layout.Ternary instance or dict with compatible properties

• title – plotly.graph_objects.layout.Title instance or dict with compatible properties

• transition – Sets transition options used during Plotly.react updates.

• treemapcolorway – Sets the default treemap slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendtreemapcolors.

• uirevision – Used to allow user interactions with the plot to persist after Plotly.react calls that are unaware of these interactions. If uirevision is omitted, or if it is given and it changed from the previous Plotly.react call, the exact new figure is used. If uirevision is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. layout.uirevision attribute serves as the default for uirevision attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set xaxis.uirevision=*time* and yaxis.uirevision=*cost*. Then if only the y data is changed, you can update yaxis.uirevision=*quantity* and the y axis range will reset but the x axis range will retain any user-driven zoom.

• uniformtext – plotly.graph_objects.layout.Uniformtext instance or dict with compatible properties

• updatemenus – A tuple of plotly.graph_objects.layout.Updatemenu instances or dicts with compatible properties

• updatemenudefaults – When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus

• violingap – Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have “width” set.

• violingroupgap – Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have “width” set.

• violinmode – Determines how violins at the same location coordinate are displayed on the graph. If “group”, the violins are plotted next to one another centered around the shared location. If “overlay”, the violins are plotted over one another, you might need to set “opacity” to see them multiple violins. Has no effect on traces that have “width” set.

• waterfallgap – Sets the gap (in plot fraction) between bars of adjacent location coordinates.

• waterfallgroupgap – Sets the gap (in plot fraction) between bars of the same location coordinate.

• waterfallmode – Determines how bars at the same location coordinate are displayed on the graph. With “group”, the bars are plotted next to one another centered around the shared location. With “overlay”, the bars are plotted over one another, you might need to reduce “opacity” to see multiple bars.

• width – Sets the plot’s width (in px).

• xaxis – plotly.graph_objects.layout.XAxis instance or dict with compatible properties

• yaxis – plotly.graph_objects.layout.YAxis instance or dict with compatible properties

Returns

Return type

Layout

plotly.graph_objects.layout¶

class plotly.graph_objects.layout.Activeselection(arg=None, fillcolor=None, opacity=None, **kwargs)¶

property fillcolor¶

Sets the color filling the active selection’ interior.

The ‘fillcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property opacity¶

Sets the opacity of the active selection.

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

class plotly.graph_objects.layout.Activeshape(arg=None, fillcolor=None, opacity=None, **kwargs)¶

property fillcolor¶

Sets the color filling the active shape’ interior.

The ‘fillcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property opacity¶

Sets the opacity of the active shape.

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

class plotly.graph_objects.layout.Annotation(arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=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, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, **kwargs)¶

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 <br> 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 string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property arrowhead¶

Sets the end annotation arrow head style.

The ‘arrowhead’ property is an 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. 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.

The ‘ax’ property accepts values of any type

Returns

Return type

Any

property axref¶

Indicates in what coordinates the tail of the annotation (ax,ay) is specified. 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. 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.

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

• One of the following enumeration values:

  [‘pixel’]

• A string that matches one of the following regular expressions:

  [‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]

Returns

Return type

Any

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

The ‘ay’ property accepts values of any type

Returns

Return type

Any

property ayref¶

Indicates in what coordinates the tail of the annotation (ax,ay) is specified. 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. 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.

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

• One of the following enumeration values:

  [‘pixel’]

• A string that matches one of the following regular expressions:

  [‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]

Returns

Return type

Any

property bgcolor¶

Sets the background color of the annotation.

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

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 string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

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 is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

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

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

• One of the following enumeration values:

  [False, ‘onoff’, ‘onout’]

Returns

Return type

Any

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.annotation.Font

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

Returns

Return type

plotly.graph_objects.layout.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.annotation.Hoverlabel

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

Returns

Return type

plotly.graph_objects.layout.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 is a boolean and must be specified as:

• A boolean value: 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 an 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 (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>, and <span> 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 is a boolean and must be specified as:

• A boolean value: 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 <br> 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. 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.

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 xclick¶

Toggle this annotation when clicking a data point whose x value is xclick rather than the annotation’s x value.

The ‘xclick’ property accepts values of any type

Returns

Return type

Any

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

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

• One of the following enumeration values:

  [‘paper’]

• A string that matches one of the following regular expressions:

  [‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]

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

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 yclick¶

Toggle this annotation when clicking a data point whose y value is yclick rather than the annotation’s y value.

The ‘yclick’ property accepts values of any type

Returns

Return type

Any

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

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

• One of the following enumeration values:

  [‘paper’]

• A string that matches one of the following regular expressions:

  [‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]

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

class plotly.graph_objects.layout.Coloraxis(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, colorbar=None, colorscale=None, reversescale=None, showscale=None, **kwargs)¶

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

The ‘autocolorscale’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

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

The ‘cauto’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

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

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

• An int or float

Returns

Return type

int|float

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

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

• An int or float

Returns

Return type

int|float

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

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

• An int or float

Returns

Return type

int|float

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

• An instance of plotly.graph_objects.layout.coloraxis.ColorBar

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

Returns

Return type

plotly.graph_objects.layout.coloraxis.ColorBar

property colorscale¶

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, 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: Blackbody,Bluered,Blues,Cividis,Earth,Electric, Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, YlGnBu,YlOrRd.

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

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

The ‘reversescale’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showscale¶

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

The ‘showscale’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

class plotly.graph_objects.layout.Colorscale(arg=None, diverging=None, sequential=None, sequentialminus=None, **kwargs)¶

property diverging¶

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

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property sequential¶

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

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property sequentialminus¶

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

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

• A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

• A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

• One of the following named colorscales:

  [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

  ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

  Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

class plotly.graph_objects.layout.Font(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

property color¶

The ‘color’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property family¶

HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.

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

• A non-empty string

Returns

Return type

str

property lineposition¶

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

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

• Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

property shadow¶

Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

The ‘shadow’ 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 size¶

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

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

Returns

Return type

int|float

property style¶

Sets whether a font should be styled with a normal or italic face from its family.

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

• One of the following enumeration values:

  [‘normal’, ‘italic’]

Returns

Return type

Any

property textcase¶

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

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

• One of the following enumeration values:

  [‘normal’, ‘word caps’, ‘upper’, ‘lower’]

Returns

Return type

Any

property variant¶

Sets the variant of the font.

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

• One of the following enumeration values:

  [‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

Returns

Return type

Any

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is an integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

Returns

Return type

int

class plotly.graph_objects.layout.Geo(arg=None, bgcolor=None, center=None, coastlinecolor=None, coastlinewidth=None, countrycolor=None, countrywidth=None, domain=None, fitbounds=None, framecolor=None, framewidth=None, lakecolor=None, landcolor=None, lataxis=None, lonaxis=None, oceancolor=None, projection=None, resolution=None, rivercolor=None, riverwidth=None, scope=None, showcoastlines=None, showcountries=None, showframe=None, showlakes=None, showland=None, showocean=None, showrivers=None, showsubunits=None, subunitcolor=None, subunitwidth=None, uirevision=None, visible=None, **kwargs)¶

property bgcolor¶

Set the background color of the map

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property center¶

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

• An instance of plotly.graph_objects.layout.geo.Center

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

Returns

Return type

plotly.graph_objects.layout.geo.Center

property coastlinecolor¶

Sets the coastline color.

The ‘coastlinecolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property coastlinewidth¶

Sets the coastline stroke width (in px).

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

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

Returns

Return type

int|float

property countrycolor¶

Sets line color of the country boundaries.

The ‘countrycolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property countrywidth¶

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

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

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

Returns

Return type

int|float

property domain¶

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.layout.geo.Domain

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

Returns

Return type

plotly.graph_objects.layout.geo.Domain

property 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 lataxis.range getting auto-filled. If “locations” (default), 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. If False, the view settings are used as-is; set this to opt out of auto-fitting.

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

• One of the following enumeration values:

  [False, ‘locations’, ‘geojson’]

Returns

Return type

Any

property framecolor¶

Sets the color the frame.

The ‘framecolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property framewidth¶

Sets the stroke width (in px) of the frame.

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

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

Returns

Return type

int|float

property lakecolor¶

Sets the color of the lakes.

The ‘lakecolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property landcolor¶

Sets the land mass color.

The ‘landcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property lataxis¶

The ‘lataxis’ property is an instance of Lataxis that may be specified as:

• An instance of plotly.graph_objects.layout.geo.Lataxis

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

Returns

Return type

plotly.graph_objects.layout.geo.Lataxis

property lonaxis¶

The ‘lonaxis’ property is an instance of Lonaxis that may be specified as:

• An instance of plotly.graph_objects.layout.geo.Lonaxis

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

Returns

Return type

plotly.graph_objects.layout.geo.Lonaxis

property oceancolor¶

Sets the ocean color

The ‘oceancolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property projection¶

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

• An instance of plotly.graph_objects.layout.geo.Projection

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

Returns

Return type

plotly.graph_objects.layout.geo.Projection

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

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

• One of the following enumeration values:

  [110, 50]

Returns

Return type

Any

property rivercolor¶

Sets color of the rivers.

The ‘rivercolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property riverwidth¶

Sets the stroke width (in px) of the rivers.

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

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

Returns

Return type

int|float

property scope¶

Set the scope of the map.

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

• One of the following enumeration values:

  [‘africa’, ‘antarctica’, ‘asia’, ‘europe’, ‘north america’, ‘oceania’, ‘south america’, ‘usa’, ‘world’]

Returns

Return type

Any

property showcoastlines¶

Sets whether or not the coastlines are drawn.

The ‘showcoastlines’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showcountries¶

Sets whether or not country boundaries are drawn.

The ‘showcountries’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showframe¶

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

The ‘showframe’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showlakes¶

Sets whether or not lakes are drawn.

The ‘showlakes’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showland¶

Sets whether or not land masses are filled in color.

The ‘showland’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showocean¶

Sets whether or not oceans are filled in color.

The ‘showocean’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showrivers¶

Sets whether or not rivers are drawn.

The ‘showrivers’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property showsubunits¶

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

The ‘showsubunits’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property subunitcolor¶

Sets the color of the subunits boundaries.

The ‘subunitcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property subunitwidth¶

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

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

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

Returns

Return type

int|float

property uirevision¶

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

The ‘uirevision’ property accepts values of any type

Returns

Return type

Any

property visible¶

Sets the default visibility of the base layers.

The ‘visible’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

class plotly.graph_objects.layout.Grid(arg=None, columns=None, domain=None, pattern=None, roworder=None, rows=None, subplots=None, xaxes=None, xgap=None, xside=None, yaxes=None, ygap=None, yside=None, **kwargs)¶

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

The ‘columns’ property is an integer and may be specified as:

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

Returns

Return type

int

property domain¶

The ‘domain’ property is an instance of Domain that may be specified as:

• An instance of plotly.graph_objects.layout.grid.Domain

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

Returns

Return type

plotly.graph_objects.layout.grid.Domain

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

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

• One of the following enumeration values:

  [‘independent’, ‘coupled’]

Returns

Return type

Any

property roworder¶

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

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

• One of the following enumeration values:

  [‘top to bottom’, ‘bottom to top’]

Returns

Return type

Any

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

The ‘rows’ property is an integer and may be specified as:

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

Returns

Return type

int

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

The ‘subplots’ property is an info array that may be specified as: * a 2D list where:

The ‘subplots[i][j]’ property is an enumeration that may be specified as: - One of the following enumeration values:

[‘’]

• A string that matches one of the following regular expressions:

  [‘^x([2-9]|[1-9][0-9]+)?y([2-9]|[1-9][0-9]+)?$’]

Returns

Return type

list

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

The ‘xaxes’ property is an info array that may be specified as: * a list of elements where:

The ‘xaxes[i]’ property is an enumeration that may be specified as: - One of the following enumeration values:

[‘’]

• A string that matches one of the following regular expressions:

  [‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]

Returns

Return type

list

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

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

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

Returns

Return type

int|float

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

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

• One of the following enumeration values:

  [‘bottom’, ‘bottom plot’, ‘top plot’, ‘top’]

Returns

Return type

Any

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

The ‘yaxes’ property is an info array that may be specified as: * a list of elements where:

The ‘yaxes[i]’ property is an enumeration that may be specified as: - One of the following enumeration values:

[‘’]

• A string that matches one of the following regular expressions:

  [‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]

Returns

Return type

list

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

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

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

Returns

Return type

int|float

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

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

• One of the following enumeration values:

  [‘left’, ‘left plot’, ‘right plot’, ‘right’]

Returns

Return type

Any

class plotly.graph_objects.layout.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, grouptitlefont=None, namelength=None, showarrow=None, **kwargs)¶

property 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

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

• One of the following enumeration values:

  [‘left’, ‘right’, ‘auto’]

Returns

Return type

Any

property bgcolor¶

Sets the background color of all hover labels on graph

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property bordercolor¶

Sets the border color of all hover labels on graph.

The ‘bordercolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property font¶

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

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

• An instance of plotly.graph_objects.layout.hoverlabel.Font

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

Returns

Return type

plotly.graph_objects.layout.hoverlabel.Font

property grouptitlefont¶

Sets the font for group titles in hover (unified modes). Defaults to hoverlabel.font.

The ‘grouptitlefont’ property is an instance of Grouptitlefont that may be specified as:

• An instance of plotly.graph_objects.layout.hoverlabel.Grouptitlefont

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

Returns

Return type

plotly.graph_objects.layout.hoverlabel.Grouptitlefont

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

The ‘namelength’ property is an integer and may be specified as:

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

Returns

Return type

int

property showarrow¶

Sets whether or not to show the hover label arrow/triangle pointing to the data point.

The ‘showarrow’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

class plotly.graph_objects.layout.Image(arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, **kwargs)¶

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

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

• One of the following enumeration values:

  [‘below’, ‘above’]

Returns

Return type

Any

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

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

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

• An int or float

Returns

Return type

int|float

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

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

• An int or float

Returns

Return type

int|float

property sizing¶

Specifies which dimension of the image to constrain.

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

• One of the following enumeration values:

  [‘fill’, ‘contain’, ‘stretch’]

Returns

Return type

Any

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

The ‘source’ property is an image URI that may be specified as:

• A remote image URI string (e.g. ‘http://www.somewhere.com/image.png’)

• A data URI image string (e.g. ‘data:image/png;base64,iVBORw0KGgoAAAANSU’)

• A PIL.Image.Image object which will be immediately converted to a data URI image string See http://pillow.readthedocs.io/en/latest/reference/Image.html

Returns

Return type

str

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

Determines whether or not this image is visible.

The ‘visible’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property 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

The ‘x’ property accepts values of any type

Returns

Return type

Any

property xanchor¶

Sets the anchor for the x position

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

• One of the following enumeration values:

  [‘left’, ‘center’, ‘right’]

Returns

Return type

Any

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

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

• One of the following enumeration values:

  [‘paper’]

• A string that matches one of the following regular expressions:

  [‘^x([2-9]|[1-9][0-9]+)?( domain)?$’]

Returns

Return type

Any

property 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

The ‘y’ property accepts values of any type

Returns

Return type

Any

property yanchor¶

Sets the anchor for the y position.

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

• One of the following enumeration values:

  [‘top’, ‘middle’, ‘bottom’]

Returns

Return type

Any

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

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

• One of the following enumeration values:

  [‘paper’]

• A string that matches one of the following regular expressions:

  [‘^y([2-9]|[1-9][0-9]+)?( domain)?$’]

Returns

Return type

Any

class plotly.graph_objects.layout.Legend(arg=None, bgcolor=None, bordercolor=None, borderwidth=None, entrywidth=None, entrywidthmode=None, font=None, groupclick=None, groupdoubleclick=None, grouptitlefont=None, indentation=None, itemclick=None, itemdoubleclick=None, itemsizing=None, itemwidth=None, maxheight=None, orientation=None, title=None, titleclick=None, titledoubleclick=None, tracegroupgap=None, traceorder=None, uirevision=None, valign=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, **kwargs)¶

property bgcolor¶

Sets the legend background color. Defaults to layout.paper_bgcolor.

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property bordercolor¶

Sets the color of the border enclosing the legend.

The ‘bordercolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property borderwidth¶

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

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 entrywidth¶

Sets the width (in px or fraction) of the legend. Use 0 to size the entry based on the text width, when entrywidthmode is set to “pixels”.

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

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

Returns

Return type

int|float

property entrywidthmode¶

Determines what entrywidth means.

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

• One of the following enumeration values:

  [‘fraction’, ‘pixels’]

Returns

Return type

Any

property font¶

Sets the font used to text the legend items.

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

• An instance of plotly.graph_objects.layout.legend.Font

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

Returns

Return type

plotly.graph_objects.layout.legend.Font

property groupclick¶

Determines the behavior on legend group item click. “toggleitem” toggles the visibility of the individual item clicked on the graph. “togglegroup” toggles the visibility of all items in the same legendgroup as the item clicked on the graph.

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

• One of the following enumeration values:

  [‘toggleitem’, ‘togglegroup’]

Returns

Return type

Any

property groupdoubleclick¶

Determines the behavior on legend group item double-click. “toggleitem” toggles the visibility of the individual item clicked on the graph. “togglegroup” toggles the visibility of all items in the same legendgroup as the item clicked on the graph. Defaults to the value of groupclick.

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

• One of the following enumeration values:

  [‘toggleitem’, ‘togglegroup’]

Returns

Return type

Any

property grouptitlefont¶

Sets the font for group titles in legend. Defaults to legend.font with its size increased about 10%.

The ‘grouptitlefont’ property is an instance of Grouptitlefont that may be specified as:

• An instance of plotly.graph_objects.layout.legend.Grouptitlefont

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

Returns

Return type

plotly.graph_objects.layout.legend.Grouptitlefont

property indentation¶

Sets the indentation (in px) of the legend entries.

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

• An int or float in the interval [-15, inf]

Returns

Return type

int|float

property 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 disables legend item click interactions.

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

• One of the following enumeration values:

  [‘toggle’, ‘toggleothers’, False]

Returns

Return type

Any

property 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 disables legend item double-click interactions.

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

• One of the following enumeration values:

  [‘toggle’, ‘toggleothers’, False]

Returns

Return type

Any

property itemsizing¶

Determines if the legend items symbols scale with their corresponding “trace” attributes or remain “constant” independent of the symbol size on the graph.

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

• One of the following enumeration values:

  [‘trace’, ‘constant’]

Returns

Return type

Any

property itemwidth¶

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

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

• An int or float in the interval [30, inf]

Returns

Return type

int|float

property maxheight¶

Sets the max height (in px) of the legend, or max height ratio (reference height * ratio) if less than or equal to 1. Default value is: 0.5 for horizontal legends; 1 for vertical legends. The minimum allowed height is 30px. For a ratio of 0.5, the legend will take up to 50% of the reference height before displaying a scrollbar. The reference height is the full layout height with the following exception: vertically oriented legends with a yref of `”paper”, located to the side of the plot. In this case, the reference height is the plot height.

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

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

Returns

Return type

int|float

property orientation¶

Sets the orientation of the legend.

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

• One of the following enumeration values:

  [‘v’, ‘h’]

Returns

Return type

Any

property title¶

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

• An instance of plotly.graph_objects.layout.legend.Title

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

Returns

Return type

plotly.graph_objects.layout.legend.Title

property titleclick¶

Determines the behavior on legend title click. “toggle” toggles the visibility of all items in the legend. “toggleothers” toggles the visibility of all other legends. False disables legend title click interactions. Defaults to “toggle” when there are multiple legends, False otherwise. Not supported for legends containing pie and pie-like traces.

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

• One of the following enumeration values:

  [‘toggle’, ‘toggleothers’, False]

Returns

Return type

Any

property titledoubleclick¶

Determines the behavior on legend title double-click. “toggle” toggles the visibility of all items in the legend. “toggleothers” toggles the visibility of all other legends. False disables legend title double-click interactions. Defaults to “toggleothers” when there are multiple legends, False otherwise. Not supported for legends containing pie and pie- like traces.

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

• One of the following enumeration values:

  [‘toggle’, ‘toggleothers’, False]

Returns

Return type

Any

property tracegroupgap¶

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

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

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

Returns

Return type

int|float

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

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

• Any combination of [‘reversed’, ‘grouped’] joined with ‘+’ characters (e.g. ‘reversed+grouped’) OR exactly one of [‘normal’] (e.g. ‘normal’)

Returns

Return type

Any

property uirevision¶

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

The ‘uirevision’ property accepts values of any type

Returns

Return type

Any

property valign¶

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

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 legend is visible.

The ‘visible’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property x¶

Sets the x position with respect to xref (in normalized coordinates) of the legend. When xref is “paper”, defaults to 1.02 for vertical legends and defaults to 0 for horizontal legends. When xref is “container”, defaults to 1 for vertical legends and defaults to 0 for horizontal legends. Must be between 0 and 1 if xref is “container”. and between “-2” and 3 if xref is “paper”.

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

• An int or float

Returns

Return type

int|float

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

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

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

• One of the following enumeration values:

  [‘container’, ‘paper’]

Returns

Return type

Any

property y¶

Sets the y position with respect to yref (in normalized coordinates) of the legend. When yref is “paper”, 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. When yref is “container”, defaults to 1. Must be between 0 and 1 if yref is “container” and between “-2” and 3 if yref is “paper”.

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

• An int or float

Returns

Return type

int|float

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

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

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

• One of the following enumeration values:

  [‘container’, ‘paper’]

Returns

Return type

Any