Bases: plotly.basedatatypes.BaseLayoutType
activeselection¶
The ‘activeselection’ property is an instance of Activeselection that may be specified as:
activeshape¶
The ‘activeshape’ property is an instance of Activeshape that may be specified as:
annotationdefaults¶
When used in a template (as layout.template.layout.annotationdefaults), sets the default property values to use for elements of layout.annotations
The ‘annotationdefaults’ property is an instance of Annotation that may be specified as:
annotations¶
The ‘annotations’ property is a tuple of instances of Annotation that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Annotation
A list or tuple of dicts of string/value properties that will be passed to the Annotation constructor
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.
The ‘autosize’ property must be specified as a bool (either True, or False)
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.
[‘convert types’, ‘strict’]
Any
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 %).
The ‘barcornerradius’ property accepts values of any type
Any
bargap¶
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
An int or float in the interval [0, 1]
int|float
bargroupgap¶
Sets the gap (in plot fraction) between bars of the same location coordinate.
An int or float in the interval [0, 1]
int|float
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.
[‘stack’, ‘group’, ‘overlay’, ‘relative’]
Any
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.
[‘’, ‘fraction’, ‘percent’]
Any
boxgap¶
Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
boxgroupgap¶
Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
calendar¶
Sets the default calendar system to use for interpreting and displaying dates throughout the plot.
[‘chinese’, ‘coptic’, ‘discworld’, ‘ethiopian’, ‘gregorian’, ‘hebrew’, ‘islamic’, ‘jalali’, ‘julian’, ‘mayan’, ‘nanakshahi’, ‘nepali’, ‘persian’, ‘taiwan’, ‘thai’, ‘ummalqura’]
Any
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.
The ‘clickmode’ property is a flaglist and may be specified as a string containing:
Any combination of [‘event’, ‘select’] joined with ‘+’ characters (e.g. ‘event+select’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
coloraxis¶
The ‘coloraxis’ property is an instance of Coloraxis that may be specified as:
colorscale¶
The ‘colorscale’ property is an instance of Colorscale that may be specified as:
colorway¶
Sets the default trace colors.
The ‘colorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
computed¶
Placeholder for exporting automargin-impacting values namely margin.t, margin.b, margin.l and margin.r in “full- json” mode.
The ‘computed’ property accepts values of any type
Any
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.
The ‘datarevision’ property accepts values of any type
Any
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.
[‘zoom’, ‘pan’, ‘select’, ‘lasso’, ‘drawclosedpath’, ‘drawopenpath’, ‘drawline’, ‘drawrect’, ‘drawcircle’, ‘orbit’, ‘turntable’, False]
Any
editrevision¶
true` configuration, other than trace names and axis titles. Defaults to layout.uirevision.
The ‘editrevision’ property accepts values of any type
Any
Controls persistence of user-driven changes in `editable
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.
The ‘extendfunnelareacolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendiciclecolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendpiecolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendsunburstcolors’ property must be specified as a bool (either True, or False)
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.
The ‘extendtreemapcolors’ property must be specified as a bool (either True, or False)
font¶
Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
The ‘font’ property is an instance of Font that may be specified as:
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.
The ‘funnelareacolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
funnelgap¶
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
An int or float in the interval [0, 1]
int|float
funnelgroupgap¶
Sets the gap (in plot fraction) between bars of the same location coordinate.
An int or float in the interval [0, 1]
int|float
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.
[‘stack’, ‘group’, ‘overlay’]
Any
geo¶
The ‘geo’ property is an instance of Geo that may be specified as:
grid¶
The ‘grid’ property is an instance of Grid that may be specified as:
height¶
Sets the plot’s height (in px).
An int or float in the interval [10, inf]
int|float
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
The ‘hiddenlabels’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
hiddenlabelssrc¶
Sets the source reference on Chart Studio Cloud for hiddenlabels.
The ‘hiddenlabelssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
hidesources¶
Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart- studio.plotly.com or on-premise).
The ‘hidesources’ property must be specified as a bool (either True, or False)
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.
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
hoverlabel¶
The ‘hoverlabel’ property is an instance of Hoverlabel that may be specified as:
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.
[‘x’, ‘y’, ‘closest’, False, ‘x unified’, ‘y unified’]
Any
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.
[‘single’, ‘overlaying’, ‘axis’]
Any
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.
The ‘iciclecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
imagedefaults¶
When used in a template (as layout.template.layout.imagedefaults), sets the default property values to use for elements of layout.images
The ‘imagedefaults’ property is an instance of Image that may be specified as:
images¶
The ‘images’ property is a tuple of instances of Image that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Image
A list or tuple of dicts of string/value properties that will be passed to the Image constructor
legend¶
The ‘legend’ property is an instance of Legend that may be specified as:
map¶
The ‘map’ property is an instance of Map that may be specified as:
mapbox¶
The ‘mapbox’ property is an instance of Mapbox that may be specified as:
margin¶
The ‘margin’ property is an instance of Margin that may be specified as:
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]}.
The ‘meta’ property accepts values of any type
Any|numpy.ndarray
metasrc¶
Sets the source reference on Chart Studio Cloud for meta.
The ‘metasrc’ property must be specified as a string or as a plotly.grid_objs.Column object
minreducedheight¶
Minimum height of the plot with margin.automargin applied (in px)
An int or float in the interval [2, inf]
int|float
minreducedwidth¶
Minimum width of the plot with margin.automargin applied (in px)
An int or float in the interval [2, inf]
int|float
modebar¶
The ‘modebar’ property is an instance of Modebar that may be specified as:
newselection¶
The ‘newselection’ property is an instance of Newselection that may be specified as:
newshape¶
The ‘newshape’ property is an instance of Newshape that may be specified as:
paper_bgcolor¶
Sets the background color of the paper where the graph is drawn.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
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.
The ‘piecolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
plot_bgcolor¶
Sets the background color of the plotting area in-between x and y axes.
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
polar¶
The ‘polar’ property is an instance of Polar that may be specified as:
re = <module 're' from '/home/circleci/.pyenv/versions/3.9.23/lib/python3.9/re.py'>¶
scattergap¶
Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to bargap.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
scene¶
The ‘scene’ property is an instance of Scene that may be specified as:
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.
[‘h’, ‘v’, ‘d’, ‘any’]
Any
selectiondefaults¶
When used in a template (as layout.template.layout.selectiondefaults), sets the default property values to use for elements of layout.selections
The ‘selectiondefaults’ property is an instance of Selection that may be specified as:
selectionrevision¶
Controls persistence of user-driven changes in selected points from all traces.
The ‘selectionrevision’ property accepts values of any type
Any
selections¶
The ‘selections’ property is a tuple of instances of Selection that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Selection
A list or tuple of dicts of string/value properties that will be passed to the Selection constructor
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.
A string
A number that will be converted to a string
shapedefaults¶
When used in a template (as layout.template.layout.shapedefaults), sets the default property values to use for elements of layout.shapes
The ‘shapedefaults’ property is an instance of Shape that may be specified as:
shapes¶
The ‘shapes’ property is a tuple of instances of Shape that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Shape
A list or tuple of dicts of string/value properties that will be passed to the Shape constructor
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.
The ‘showlegend’ property must be specified as a bool (either True, or False)
sliderdefaults¶
When used in a template (as layout.template.layout.sliderdefaults), sets the default property values to use for elements of layout.sliders
The ‘sliderdefaults’ property is an instance of Slider that may be specified as:
sliders¶
The ‘sliders’ property is a tuple of instances of Slider that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Slider
A list or tuple of dicts of string/value properties that will be passed to the Slider constructor
smith¶
The ‘smith’ property is an instance of Smith that may be specified as:
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.
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
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.
The ‘sunburstcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
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.
The ‘template’ property is an instance of Template that may be specified as:
An instance of
plotly.graph_objects.layout.TemplateA dict of string/value properties that will be passed to the Template constructor
The name of a registered template where current registered templates are stored in the plotly.io.templates configuration object. The names of all registered templates can be retrieved with:
>>> import plotly.io as pio >>> list(pio.templates) ['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...]A string containing multiple registered template names, joined on ‘+’ characters (e.g. ‘template1+template2’). In this case the resulting template is computed by merging together the collection of registered templates
ternary¶
The ‘ternary’ property is an instance of Ternary that may be specified as:
title¶
The ‘title’ property is an instance of Title that may be specified as:
transition¶
Sets transition options used during Plotly.react updates.
The ‘transition’ property is an instance of Transition that may be specified as:
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.
The ‘treemapcolorway’ property is a colorlist that may be specified as a tuple, list, one-dimensional numpy array, or pandas Series of valid color strings
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.
The ‘uirevision’ property accepts values of any type
Any
uniformtext¶
The ‘uniformtext’ property is an instance of Uniformtext that may be specified as:
When used in a template (as layout.template.layout.updatemenudefaults), sets the default property values to use for elements of layout.updatemenus
The ‘updatemenudefaults’ property is an instance of Updatemenu that may be specified as:
The ‘updatemenus’ property is a tuple of instances of Updatemenu that may be specified as:
A list or tuple of instances of plotly.graph_objects.layout.Updatemenu
A list or tuple of dicts of string/value properties that will be passed to the Updatemenu constructor
violingap¶
Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
violingroupgap¶
Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have “width” set.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
waterfallgap¶
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
An int or float in the interval [0, 1]
int|float
waterfallgroupgap¶
Sets the gap (in plot fraction) between bars of the same location coordinate.
An int or float in the interval [0, 1]
int|float
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.
[‘group’, ‘overlay’]
Any
width¶
Sets the plot’s width (in px).
An int or float in the interval [10, inf]
int|float
xaxis¶
The ‘xaxis’ property is an instance of XAxis that may be specified as:
yaxis¶
The ‘yaxis’ property is an instance of YAxis that may be specified as:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4