surface Traces
A
plotly.graph_objects.Surface
trace is a graph object in the figure's
data
list with any of the named arguments or attributes listed below.
The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a 2D list. Coordinates in `x` and `y` can either be 1D lists or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the `z` values by default. For custom color scales, use `surfacecolor` which should be a 2D list, where its bounds can be controlled using `cmin` and `cmax`.
fig.update_traces(name=<VALUE>, selector=dict(type='surface')) Sets the trace name. The trace name appears as the legend item and on hover.
fig.update_traces(visible=<VALUE>, selector=dict(type='surface')) True | False | "legendonly" ) True
Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
fig.update_traces(showlegend=<VALUE>, selector=dict(type='surface')) Determines whether or not an item corresponding to this trace is shown in the legend.
fig.update_traces(legend=<VALUE>, selector=dict(type='surface')) legend
Sets the reference to a legend to show this trace in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.
fig.update_traces(legendrank=<VALUE>, selector=dict(type='surface')) 1000
Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.
fig.update_traces(legendgroup=<VALUE>, selector=dict(type='surface')) ""
Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='surface')) fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='surface')) Sets this legend group's title font.
fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='surface')) fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='surface')) 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.
fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='surface')) "under", "over", "through" joined with a "+" OR "none". "under", "over", "under+over", "under+over+through", "none" "none"
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.
fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='surface')) "none"
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.
fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='surface')) fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='surface')) "normal" | "italic" ) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='surface')) "normal" | "word caps" | "upper" | "lower" ) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='surface')) "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" ) "normal"
Sets the variant of the font.
fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='surface')) normal
Sets the weight (or boldness) of the font.
fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='surface')) ""
Sets the title of the legend group.
fig.update_traces(legendwidth=<VALUE>, selector=dict(type='surface')) Sets the width (in px or fraction) of the legend for this trace.
fig.update_traces(opacity=<VALUE>, selector=dict(type='surface')) 1
Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
fig.update_traces(ids=<VALUE>, selector=dict(type='surface')) Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
fig.update_traces(x=<VALUE>, selector=dict(type='surface')) Sets the x coordinates.
fig.update_traces(y=<VALUE>, selector=dict(type='surface')) Sets the y coordinates.
fig.update_traces(z=<VALUE>, selector=dict(type='surface')) Sets the z coordinates.
fig.update_traces(surfacecolor=<VALUE>, selector=dict(type='surface')) Sets the surface color values, used for setting a color scale independent of `z`.
fig.update_traces(text=<VALUE>, selector=dict(type='surface')) ""
Sets the text elements associated with each z value. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
fig.update_traces(hovertext=<VALUE>, selector=dict(type='surface')) ""
Same as `text`.
fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='surface')) "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip". "x", "y", "x+y", "x+y+z", "all" "all"
Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='surface')) ""
Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: True`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='surface')) ""
Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"By default the values are formatted using `xaxis.hoverformat`.
fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='surface')) ""
Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"By default the values are formatted using `yaxis.hoverformat`.
fig.update_traces(meta=<VALUE>, selector=dict(type='surface')) Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
fig.update_traces(customdata=<VALUE>, selector=dict(type='surface')) Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
fig.update_traces(scene=<VALUE>, selector=dict(type='surface')) scene
Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
fig.update_traces(coloraxis=<VALUE>, selector=dict(type='surface')) Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
fig.update_traces(colorbar=dict(...), selector=dict(type='surface')) fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='surface')) "rgba(0,0,0,0)"
Sets the color of padded area.
fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='surface')) "#444"
Sets the axis line color.
fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='surface')) 0
Sets the width (in px) or the border enclosing this color bar.
fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='surface')) Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='surface')) "none" | "e" | "E" | "power" | "SI" | "B" ) "B"
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='surface')) Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.
fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='surface')) 1
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='surface')) "fraction" | "pixels" ) "fraction"
Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='surface')) 3
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='surface')) 0
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='surface')) "h" | "v" ) "v"
Sets the orientation of the colorbar.
fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='surface')) "#444"
Sets the axis line color.
fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='surface')) 1
Sets the width (in px) of the axis line.
fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='surface')) If "True", even 4-digit integers are separated
fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='surface')) "all" | "first" | "last" | "none" ) "all"
If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='surface')) True
Determines whether or not the tick labels are drawn.
fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='surface')) "all" | "first" | "last" | "none" ) "all"
If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='surface')) "all" | "first" | "last" | "none" ) "all"
Same as `showtickprefix` but for tick suffixes.
fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='surface')) 30
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='surface')) "fraction" | "pixels" ) "pixels"
Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='surface')) Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='surface')) "auto"
Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='surface')) "#444"
Sets the tick color.
fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='surface')) Sets the color bar's tick label font
fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='surface')) fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='surface')) 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.
fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='surface')) "under", "over", "through" joined with a "+" OR "none". "under", "over", "under+over", "under+over+through", "none" "none"
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.
fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='surface')) "none"
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.
fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='surface')) fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='surface')) "normal" | "italic" ) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='surface')) "normal" | "word caps" | "upper" | "lower" ) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='surface')) "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" ) "normal"
Sets the variant of the font.
fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='surface')) normal
Sets the weight (or boldness) of the font.
fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='surface')) ""
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='surface')) data[type=surface].colorbar.tickformatstops[] range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
data[type=surface].colorbar.tickformatstops[] True
Determines whether or not this stop is used. If `False`, this stop is ignored even within its `dtickrange`.
data[type=surface].colorbar.tickformatstops[] 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.
data[type=surface].colorbar.tickformatstops[] 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`.
data[type=surface].colorbar.tickformatstops[] ""
string - dtickformat for described zoom level, the same as "tickformat"
fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='surface')) "allow" | "hide past div" | "hide past domain" )
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='surface')) "outside" | "inside" | "outside top" | "inside top" | "outside left" | "inside left" | "outside right" | "inside right" | "outside bottom" | "inside bottom" ) "outside"
Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='surface')) 1
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array".
fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='surface')) 5
Sets the tick length (in px).
fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='surface')) "auto" | "linear" | "array" )
Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='surface')) ""
Sets a tick label prefix.
fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='surface')) "outside" | "inside" | "" ) ""
Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='surface')) ""
Sets a tick label suffix.
fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='surface')) Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='surface')) Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='surface')) 1
Sets the tick width (in px).
fig.update_traces(colorbar_title=dict(...), selector=dict(type='surface')) fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='surface')) Sets this color bar's title font.
fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='surface')) fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='surface')) 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.
fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='surface')) "under", "over", "through" joined with a "+" OR "none". "under", "over", "under+over", "under+over+through", "none" "none"
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.
fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='surface')) "none"
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.
fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='surface')) fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='surface')) "normal" | "italic" ) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='surface')) "normal" | "word caps" | "upper" | "lower" ) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='surface')) "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" ) "normal"
Sets the variant of the font.
fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='surface')) normal
Sets the weight (or boldness) of the font.
fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='surface')) "right" | "top" | "bottom" )
Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='surface')) Sets the title of the color bar.
fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='surface')) Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='surface')) "left" | "center" | "right" )
Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='surface')) 10
Sets the amount of padding (in px) along the x direction.
fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='surface')) "container" | "paper" ) "paper"
Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='surface')) Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='surface')) "top" | "middle" | "bottom" )
Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='surface')) 10
Sets the amount of padding (in px) along the y direction.
fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='surface')) "container" | "paper" ) "paper"
Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='surface')) 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.
fig.update_traces(colorscale=<VALUE>, selector=dict(type='surface')) Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
fig.update_traces(showscale=<VALUE>, selector=dict(type='surface')) True
Determines whether or not a colorbar is displayed for this trace.
fig.update_traces(reversescale=<VALUE>, selector=dict(type='surface')) 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.
fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='surface')) ""
Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"By default the values are formatted using `zaxis.hoverformat`.
fig.update_traces(cauto=<VALUE>, selector=dict(type='surface')) True
Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `False` when `cmin` and `cmax` are set by the user.
fig.update_traces(cmax=<VALUE>, selector=dict(type='surface')) Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well.
fig.update_traces(cmid=<VALUE>, selector=dict(type='surface')) 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 z or surfacecolor. Has no effect when `cauto` is `False`.
fig.update_traces(cmin=<VALUE>, selector=dict(type='surface')) Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well.
fig.update_traces(connectgaps=<VALUE>, selector=dict(type='surface')) Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
fig.update_traces(contours=dict(...), selector=dict(type='surface')) fig.update_traces(contours_x=dict(...), selector=dict(type='surface')) fig.update_traces(contours_x_color=<VALUE>, selector=dict(type='surface')) "#444"
Sets the color of the contour lines.
fig.update_traces(contours_x_end=<VALUE>, selector=dict(type='surface')) Sets the end contour level value. Must be more than `contours.start`
fig.update_traces(contours_x_highlight=<VALUE>, selector=dict(type='surface')) True
Determines whether or not contour lines about the x dimension are highlighted on hover.
fig.update_traces(contours_x_highlightcolor=<VALUE>, selector=dict(type='surface')) "#444"
Sets the color of the highlighted contour lines.
fig.update_traces(contours_x_highlightwidth=<VALUE>, selector=dict(type='surface')) 2
Sets the width of the highlighted contour lines.
fig.update_traces(contours_x_project=dict(...), selector=dict(type='surface')) fig.update_traces(contours_x_project_x=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_x_project_y=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_x_project_z=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_x_show=<VALUE>, selector=dict(type='surface')) Determines whether or not contour lines about the x dimension are drawn.
fig.update_traces(contours_x_size=<VALUE>, selector=dict(type='surface')) Sets the step between each contour level. Must be positive.
fig.update_traces(contours_x_start=<VALUE>, selector=dict(type='surface')) Sets the starting contour level value. Must be less than `contours.end`
fig.update_traces(contours_x_usecolormap=<VALUE>, selector=dict(type='surface')) An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
fig.update_traces(contours_x_width=<VALUE>, selector=dict(type='surface')) 2
Sets the width of the contour lines.
fig.update_traces(contours_y=dict(...), selector=dict(type='surface')) fig.update_traces(contours_y_color=<VALUE>, selector=dict(type='surface')) "#444"
Sets the color of the contour lines.
fig.update_traces(contours_y_end=<VALUE>, selector=dict(type='surface')) Sets the end contour level value. Must be more than `contours.start`
fig.update_traces(contours_y_highlight=<VALUE>, selector=dict(type='surface')) True
Determines whether or not contour lines about the y dimension are highlighted on hover.
fig.update_traces(contours_y_highlightcolor=<VALUE>, selector=dict(type='surface')) "#444"
Sets the color of the highlighted contour lines.
fig.update_traces(contours_y_highlightwidth=<VALUE>, selector=dict(type='surface')) 2
Sets the width of the highlighted contour lines.
fig.update_traces(contours_y_project=dict(...), selector=dict(type='surface')) fig.update_traces(contours_y_project_x=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_y_project_y=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_y_project_z=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_y_show=<VALUE>, selector=dict(type='surface')) Determines whether or not contour lines about the y dimension are drawn.
fig.update_traces(contours_y_size=<VALUE>, selector=dict(type='surface')) Sets the step between each contour level. Must be positive.
fig.update_traces(contours_y_start=<VALUE>, selector=dict(type='surface')) Sets the starting contour level value. Must be less than `contours.end`
fig.update_traces(contours_y_usecolormap=<VALUE>, selector=dict(type='surface')) An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
fig.update_traces(contours_y_width=<VALUE>, selector=dict(type='surface')) 2
Sets the width of the contour lines.
fig.update_traces(contours_z=dict(...), selector=dict(type='surface')) fig.update_traces(contours_z_color=<VALUE>, selector=dict(type='surface')) "#444"
Sets the color of the contour lines.
fig.update_traces(contours_z_end=<VALUE>, selector=dict(type='surface')) Sets the end contour level value. Must be more than `contours.start`
fig.update_traces(contours_z_highlight=<VALUE>, selector=dict(type='surface')) True
Determines whether or not contour lines about the z dimension are highlighted on hover.
fig.update_traces(contours_z_highlightcolor=<VALUE>, selector=dict(type='surface')) "#444"
Sets the color of the highlighted contour lines.
fig.update_traces(contours_z_highlightwidth=<VALUE>, selector=dict(type='surface')) 2
Sets the width of the highlighted contour lines.
fig.update_traces(contours_z_project=dict(...), selector=dict(type='surface')) fig.update_traces(contours_z_project_x=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_z_project_y=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_z_project_z=<VALUE>, selector=dict(type='surface')) Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "True" (the default), the projected lines are shown on hover. If `show` is set to "True", the projected lines are shown in permanence.
fig.update_traces(contours_z_show=<VALUE>, selector=dict(type='surface')) Determines whether or not contour lines about the z dimension are drawn.
fig.update_traces(contours_z_size=<VALUE>, selector=dict(type='surface')) Sets the step between each contour level. Must be positive.
fig.update_traces(contours_z_start=<VALUE>, selector=dict(type='surface')) Sets the starting contour level value. Must be less than `contours.end`
fig.update_traces(contours_z_usecolormap=<VALUE>, selector=dict(type='surface')) An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
fig.update_traces(contours_z_width=<VALUE>, selector=dict(type='surface')) 2
Sets the width of the contour lines.
fig.update_traces(hidesurface=<VALUE>, selector=dict(type='surface')) Determines whether or not a surface is drawn. For example, set `hidesurface` to "False" `contours.x.show` to "True" and `contours.y.show` to "True" to draw a wire frame plot.
fig.update_traces(hoverlabel=dict(...), selector=dict(type='surface')) fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='surface')) "left" | "right" | "auto" ) "auto"
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
fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='surface')) Sets the background color of the hover labels for this trace
fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='surface')) Sets the border color of the hover labels for this trace.
fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='surface')) Sets the font used in hover labels.
fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='surface')) fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='surface')) 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.
fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='surface')) "under", "over", "through" joined with a "+" OR "none". "under", "over", "under+over", "under+over+through", "none" "none"
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.
fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='surface')) "none"
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.
fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='surface')) fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='surface')) "normal" | "italic" ) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='surface')) "normal" | "word caps" | "upper" | "lower" ) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='surface')) "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" ) "normal"
Sets the variant of the font.
fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='surface')) normal
Sets the weight (or boldness) of the font.
fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='surface')) 15
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.
fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='surface')) True
Sets whether or not to show the hover label arrow/triangle pointing to the data point.
fig.update_traces(lighting=dict(...), selector=dict(type='surface')) fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='surface')) 0.8
Ambient light increases overall color visibility but can wash out the image.
fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='surface')) 0.8
Represents the extent that incident rays are reflected in a range of angles.
fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='surface')) 0.2
Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='surface')) 0.5
Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='surface')) 0.05
Represents the level that incident rays are reflected in a single direction, causing shine.
fig.update_traces(lightposition=dict(...), selector=dict(type='surface')) fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='surface')) 10
Numeric vector, representing the X coordinate for each vertex.
fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='surface')) 10000
Numeric vector, representing the Y coordinate for each vertex.
fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='surface')) 0
Numeric vector, representing the Z coordinate for each vertex.
fig.update_traces(opacityscale=<VALUE>, selector=dict(type='surface')) Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
fig.update_traces(xcalendar=<VALUE>, selector=dict(type='surface')) "chinese" | "coptic" | "discworld" | "ethiopian" | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" ) "gregorian"
Sets the calendar system to use with `x` date data.
fig.update_traces(ycalendar=<VALUE>, selector=dict(type='surface')) "chinese" | "coptic" | "discworld" | "ethiopian" | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" ) "gregorian"
Sets the calendar system to use with `y` date data.
fig.update_traces(zcalendar=<VALUE>, selector=dict(type='surface')) "chinese" | "coptic" | "discworld" | "ethiopian" | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" ) "gregorian"
Sets the calendar system to use with `z` date data.
fig.update_traces(uirevision=<VALUE>, selector=dict(type='surface')) Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: True` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: True}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
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