You are currently viewing the new Beta Editor Docs.
Switch to the Classic Editor Docs
You are currently viewing the Classic Editor Docs.
Switch to the Beta Editor Docs

plotly.graph_objs.contourcarpet Module

Functions

plotly.graph_objs.contourcarpet.ColorBar([thicknessmode=], [thickness=], [lenmode=], [len=], [x=], [xanchor=], [xpad=], [y=], [yanchor=], [ypad=], [outlinecolor=], [outlinewidth=], [bordercolor=], [borderwidth=], [bgcolor=], [tickmode=], [nticks=], [tick0=], [dtick=], [tickvals=], [ticktext=], [ticks=], [ticklabelposition=], [ticklen=], [tickwidth=], [tickcolor=], [showticklabels=], [tickfont=], [tickangle=], [tickformat=], [tickformatstop=], [tickprefix=], [showtickprefix=], [ticksuffix=], [showticksuffix=], [separatethousands=], [exponentformat=], [minexponent=], [showexponent=], [title=], [_deprecated=], [tickvalssrc=], [ticktextsrc=]) → ColorBar

Create a new ‘ColorBar’ object

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

  • thickness - Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

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

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

  • x - Sets the x position of the color bar (in plot fraction).

  • xanchor - Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar.

  • xpad - Sets the amount of padding (in px) along the x direction.

  • y - Sets the y position of the color bar (in plot fraction).

  • yanchor - Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar.

  • ypad - Sets the amount of padding (in px) along the y direction.

  • outlinecolor - Sets the axis line color.

  • outlinewidth - Sets the width (in px) of the axis line.

  • bordercolor - Sets the axis line color.

  • borderwidth - Sets the width (in px) or the border enclosing this color bar.

  • bgcolor - Sets the color of padded area.

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

  • nticks - 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*.

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

  • dtick - 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*

  • tickvals - Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.

  • ticktext - Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.

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

  • ticklabelposition - Determines where tick labels are drawn.

  • ticklen - Sets the tick length (in px).

  • tickwidth - Sets the tick width (in px).

  • tickcolor - Sets the tick color.

  • showticklabels - Determines whether or not the tick labels are drawn.

  • tickfont - Sets the color bar's tick label font

  • tickangle - Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

  • tickformat - 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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: *%{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*

  • tickprefix - Sets a tick label prefix.

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

  • ticksuffix - Sets a tick label suffix.

  • showticksuffix - Same as `showtickprefix` but for tick suffixes.

  • separatethousands - If "true", even 4-digit integers are separated

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

  • minexponent - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

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

  • tickvalssrc - Sets the source reference on Chart Studio Cloud for tickvals .

  • ticktextsrc - Sets the source reference on Chart Studio Cloud for ticktext .


plotly.graph_objs.contourcarpet.Contours([type=], [start=], [end=], [size=], [coloring=], [showlines=], [showlabels=], [labelfont=], [labelformat=], [operation=], [value=], [impliedEdits=]) → Contours

Create a new ‘Contours’ object

  • type - If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.

  • start - Sets the starting contour level value. Must be less than `contours.end`

  • end - Sets the end contour level value. Must be more than `contours.start`

  • size - Sets the step between each contour level. Must be positive.

  • coloring - Determines the coloring method showing the contour values. If *fill*, coloring is done evenly between each contour level If *lines*, coloring is done on the contour lines. If *none*, no coloring is applied on this trace.

  • showlines - Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to *fill*.

  • showlabels - Determines whether to label the contour lines with their values.

  • labelfont - Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.

  • labelformat - Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

  • operation - Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.

  • value - Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) *value* is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) *value* is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.


plotly.graph_objs.contourcarpet.Line([color=], [width=], [dash=], [smoothing=]) → Line

Create a new ‘Line’ object

  • color - Sets the color of the contour level. Has no effect if `contours.coloring` is set to *lines*.

  • width - Sets the contour line width in (in px) Defaults to *0.5* when `contours.type` is *levels*. Defaults to *2* when `contour.type` is *constraint*.

  • dash - Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).

  • smoothing - Sets the amount of smoothing for the contour lines, where *0* corresponds to no smoothing.


plotly.graph_objs.contourcarpet.Stream([token=], [maxpoints=]) → Stream

Create a new ‘Stream’ object

  • token - The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

  • maxpoints - Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.


Globals




plotly.graph_objs.contourcarpet