plotly.graph_objects.Contourcarpet — 6.6.0 documentation
arg – dict of properties compatible with this constructor or an instance of
plotly.graph_objects.Contourcarpeta – Sets the x coordinates.
a0 – Alternate to
x. Builds a linear space of x coordinates. Use withdxwherex0is the starting coordinate anddxthe step.asrc – Sets the source reference on Chart Studio Cloud for
a.atype – If “array”, the heatmap’s x coordinates are given by “x” (the default behavior when
xis provided). If “scaled”, the heatmap’s x coordinates are given by “x0” and “dx” (the default behavior whenxis not provided).autocolorscale – Determines whether the colorscale is a default palette (
autocolorscale: true) or the palette determined bycolorscale. In casecolorscaleis unspecified orautocolorscaleis true, the default palette will be chosen according to whether numbers in thecolorarray are all positive, all negative or mixed.autocontour – 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 incontours.b – Sets the y coordinates.
b0 – Alternate to
y. Builds a linear space of y coordinates. Use withdywherey0is the starting coordinate anddythe step.bsrc – Sets the source reference on Chart Studio Cloud for
b.btype – If “array”, the heatmap’s y coordinates are given by “y” (the default behavior when
yis provided) If “scaled”, the heatmap’s y coordinates are given by “y0” and “dy” (the default behavior whenyis not provided)carpet – The
carpetof the carpet axes on which this contour trace liescoloraxis – 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.colorbar –
plotly.graph_objects.contourcarpet.ColorBarinstance or dict with compatible propertiescolorscale – 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, usezminandzmax. Alternatively,colorscalemay be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.contours –
plotly.graph_objects.contourcarpet.Contoursinstance or dict with compatible propertiescustomdata – 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
customdatasrc – Sets the source reference on Chart Studio Cloud for
customdata.da – Sets the x coordinate step. See
x0for more info.db – Sets the y coordinate step. See
y0for more info.fillcolor – Sets the fill color if
contours.typeis “constraint”. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.hovertext – Same as
text.hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext.ids – 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.
idssrc – Sets the source reference on Chart Studio Cloud for
ids.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.legendgroup – 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.
legendgrouptitle –
plotly.graph_objects.contourcarpet.Legendgroupt itleinstance or dict with compatible propertieslegendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed”
legend.traceorderthey 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.legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line –
plotly.graph_objects.contourcarpet.Lineinstance or dict with compatible propertiesmeta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace
name, graph, axis and colorbartitle.text, annotationtextrangeselector,updatemenuesandsliderslabeltext all supportmeta. To access the tracemetavalues in an attribute in the same trace, simply use%{meta[i]}whereiis the index or key of themetaitem in question. To access tracemetain layout attributes, use%{data[n[.meta[i]}whereiis the index or key of themetaandnis the trace index.metasrc – Sets the source reference on Chart Studio Cloud for
meta.name – Sets the trace name. The trace name appears as the legend item and on hover.
ncontours – 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 ifautocontouris True or ifcontours.sizeis missing.opacity – Sets the opacity of the trace.
reversescale – Reverses the color mapping if true. If true,
zminwill correspond to the last color in the array andzmaxwill correspond to the first color.showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
showscale – Determines whether or not a colorbar is displayed for this trace.
stream –
plotly.graph_objects.contourcarpet.Streaminstance or dict with compatible propertiestext – Sets the text elements associated with each z value.
textsrc – Sets the source reference on Chart Studio Cloud for
text.transpose – Transposes the z data.
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the trace:
constraintrangeinparcoordstraces, as well as someeditable: truemodifications such asnameandcolorbar.title. Defaults tolayout.uirevision. Note that other user-driven trace attribute changes are controlled bylayoutattributes:trace.visibleis controlled bylayout.legend.uirevision,selectedpointsis controlled bylayout.selectionrevision, andcolorbar.(x|y)(accessible withconfig: {editable: true}) is controlled bylayout.editrevision. Trace changes are tracked byuid, which only falls back on trace index if nouidis provided. So if your app can add/remove traces before the end of thedataarray, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace auidthat stays with it as it moves.visible – 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).
xaxis – 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 tolayout.xaxis2, and so on.yaxis – 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 tolayout.yaxis2, and so on.z – Sets the z data.
zauto – Determines whether or not the color domain is computed with respect to the input data (here in
z) or the bounds set inzminandzmaxDefaults tofalsewhenzminandzmaxare set by the user.zmax – Sets the upper bound of the color domain. Value should have the same units as in
zand if set,zminmust be set as well.zmid – Sets the mid-point of the color domain by scaling
zminand/orzmaxto be equidistant to this point. Value should have the same units as inz. Has no effect whenzautoisfalse.zmin – Sets the lower bound of the color domain. Value should have the same units as in
zand if set,zmaxmust be set as well.zorder – Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher
zorderappear in front of those with lowerzorder.zsrc – Sets the source reference on Chart Studio Cloud for
z.