Contour

Corresponding Plotly trace type.

Switch indicating whether the trace supports animation of its data.

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

Determines whether or not an item corresponding to this trace is shown in the legend.

Sets the legend group for this trace.

Traces part of the same legend group hide/show at the same time when toggling legend items.

Sets the opacity of the trace.

Sets the trace name.

The trace name appear as the legend item and on hover.

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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.

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

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.

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.

Undocumented

Undocumented

Undocumented

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.

Sets the z data.

Sets the x coordinates.

Alternate to x.

Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Sets the x coordinate step.

See x0 for more info.

Sets the y coordinates.

Alternate to y.

Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Sets the y coordinate step.

See y0 for more info.

Only relevant when the axis type is date.

Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Only relevant when the axis type is date.

Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Only relevant when the axis type is date.

Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

Only relevant when the axis type is date.

Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

Only relevant when the axis type is date.

Sets the alignment of data points on the x axis.

Only relevant when the axis type is date.

Sets the alignment of data points on the y axis.

Sets the text elements associated with each z value.

Same as text.

Transposes the z data.

If array, the heatmap’s x coordinates are given by x (the default behavior when x is provided).

If scaled, the heatmap’s x coordinates are given by x0 and dx (the default behavior when x is not provided).

If array, the heatmap’s y coordinates are given by y (the default behavior when y is provided) If scaled, the heatmap’s y coordinates are given by y0 and dy (the default behavior when y is not provided)

Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python.

See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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#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 “{fullData.name}”. To hide the secondary box completely, use an empty tag <extra></extra>.

Determines whether or not gaps (i.e.

{nan} or missing values) in the z data have hover labels associated with them.

Determines whether or not gaps (i.e.

{nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array otherwise it is defaulted to false.

Sets the fill color if contours.type is constraint.

Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

Determines whether or not the contour level attributes are picked by an algorithm.

If true, the number of contour levels can be set in ncontours. If false, set the contour level attributes in contours.

Sets the maximum number of contour levels.

The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is true or if contours.size is missing.

Undocumented

Undocumented

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

Sets the lower bound of the color domain.

Value should have the same units as in z and if set, zmax must be set as well.

Sets the upper bound of the color domain.

Value should have the same units as in z and if set, zmin must be set as well.

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point.

Value should have the same units as in z. Has no effect when zauto is false.

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, usezmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

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.

Reverses the color mapping if true.

If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

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

Undocumented

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.

Sets the calendar system to use with x date data.

Sets the calendar system to use with y date data.

Sets a reference between this trace’s x coordinates and a 2D cartesian x axis.

If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.

If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

Creates Contour object from the most frequently used properties.

Creates Contour object with specified properties.

Encodes the object in a format compatible with Plotly.