Black Lives Matter. Please consider donating to Black Girls Code today.

Python Figure Reference: carpet Traces

A plotly.graph_objects.Carpet trace is a graph object in the figure's data list with any of the named arguments or attributes listed below.

The data describing carpet axis layout is set in `y` and (optionally) also `x`. If only `y` is present, `x` the plot is interpreted as a cheater plot and is filled in using the `y` values. `x` and `y` may either be 2D arrays matching with each dimension matching that of `a` and `b`, or they may be 1D arrays with total length equal to that of `a` and `b`.

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='carpet'))
    Type: string

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

  • visible
    Code: fig.update_traces(visible=<VALUE>, selector=dict(type='carpet'))
    Type: enumerated , one of ( True | False | "legendonly" )
    Default: 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).

  • opacity
    Code: fig.update_traces(opacity=<VALUE>, selector=dict(type='carpet'))
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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.

  • x
    Code: fig.update_traces(x=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    A two dimensional array of x coordinates at each carpet point. If ommitted, the plot is a cheater plot and the xaxis is hidden by default.

  • y
    Code: fig.update_traces(y=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    A two dimensional array of y coordinates at each carpet point.

  • a
    Code: fig.update_traces(a=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    An array containing values of the first parameter value

  • a0
    Code: fig.update_traces(a0=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 0

    Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step.

  • da
    Code: fig.update_traces(da=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 1

    Sets the a coordinate step. See `a0` for more info.

  • b
    Code: fig.update_traces(b=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    A two dimensional array of y coordinates at each carpet point.

  • b0
    Code: fig.update_traces(b0=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 0

    Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step.

  • db
    Code: fig.update_traces(db=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 1

    Sets the b coordinate step. See `b0` for more info.

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='carpet'))
    Type: number or categorical coordinate string

    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.

  • customdata
    Code: fig.update_traces(customdata=<VALUE>, selector=dict(type='carpet'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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

  • aaxis
    Code: fig.update_traces(aaxis=dict(...), selector=dict(type='carpet'))
    Type: dict containing one or more of the keys listed below.
    • color
      Code: fig.update_traces(aaxis_color=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

    • smoothing
      Code: fig.update_traces(aaxis_smoothing=<VALUE>, selector=dict(type='carpet'))
      Type: number between or equal to 0 and 1.3
      Default: 1
    • title
      Code: fig.update_traces(aaxis_title=dict(...), selector=dict(type='carpet'))
      Type: dict containing one or more of the keys listed below.
      • text
        Code: fig.update_traces(aaxis_title_text=<VALUE>, selector=dict(type='carpet'))
        Type: string
        Default: ""

        Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

      • font
        Code: fig.update_traces(aaxis_title_font=dict(...), selector=dict(type='carpet'))
        Type: dict containing one or more of the keys listed below.

        Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

        • family
          Code: fig.update_traces(aaxis_title_font_family=<VALUE>, selector=dict(type='carpet'))
          Type: string

          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

        • size
          Code: fig.update_traces(aaxis_title_font_size=<VALUE>, selector=dict(type='carpet'))
          Type: number greater than or equal to 1
        • color
          Code: fig.update_traces(aaxis_title_font_color=<VALUE>, selector=dict(type='carpet'))
          Type: color
      • offset
        Code: fig.update_traces(aaxis_title_offset=<VALUE>, selector=dict(type='carpet'))
        Type: number
        Default: 10

        An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute.

    • type
      Code: fig.update_traces(aaxis_type=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "-" | "linear" | "date" | "category" )
      Default: "-"

      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

    • autorange
      Code: fig.update_traces(aaxis_autorange=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( True | False | "reversed" )
      Default: True

      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "False".

    • rangemode
      Code: fig.update_traces(aaxis_rangemode=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "normal" | "tozero" | "nonnegative" )
      Default: "normal"

      If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.

    • range
      Code: fig.update_traces(aaxis_range=<VALUE>, selector=dict(type='carpet'))
      Type: list

      Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

    • fixedrange
      Code: fig.update_traces(aaxis_fixedrange=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not this axis is zoom-able. If True, then zoom is disabled.

    • cheatertype
      Code: fig.update_traces(aaxis_cheatertype=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "index" | "value" )
      Default: "value"
    • tickmode
      Code: fig.update_traces(aaxis_tickmode=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "linear" | "array" )
      Default: "array"
    • nticks
      Code: fig.update_traces(aaxis_nticks=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 0
      Default: 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".

    • tickvals
      Code: fig.update_traces(aaxis_tickvals=<VALUE>, selector=dict(type='carpet'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

    • ticktext
      Code: fig.update_traces(aaxis_ticktext=<VALUE>, selector=dict(type='carpet'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

    • showticklabels
      Code: fig.update_traces(aaxis_showticklabels=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "start" | "end" | "both" | "none" )
      Default: "start"

      Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

    • tickfont
      Code: fig.update_traces(aaxis_tickfont=dict(...), selector=dict(type='carpet'))
      Type: dict containing one or more of the keys listed below.

      Sets the tick font.

      • family
        Code: fig.update_traces(aaxis_tickfont_family=<VALUE>, selector=dict(type='carpet'))
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

      • size
        Code: fig.update_traces(aaxis_tickfont_size=<VALUE>, selector=dict(type='carpet'))
        Type: number greater than or equal to 1
      • color
        Code: fig.update_traces(aaxis_tickfont_color=<VALUE>, selector=dict(type='carpet'))
        Type: color
    • tickangle
      Code: fig.update_traces(aaxis_tickangle=<VALUE>, selector=dict(type='carpet'))
      Type: angle
      Default: "auto"

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

    • tickprefix
      Code: fig.update_traces(aaxis_tickprefix=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      Sets a tick label prefix.

    • showtickprefix
      Code: fig.update_traces(aaxis_showtickprefix=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "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.

    • ticksuffix
      Code: fig.update_traces(aaxis_ticksuffix=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      Sets a tick label suffix.

    • showticksuffix
      Code: fig.update_traces(aaxis_showticksuffix=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • showexponent
      Code: fig.update_traces(aaxis_showexponent=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "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.

    • exponentformat
      Code: fig.update_traces(aaxis_exponentformat=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
      Default: "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.

    • minexponent
      Code: fig.update_traces(aaxis_minexponent=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 3

      Hide SI prefix for 10^n if |n| is below this number

    • separatethousands
      Code: fig.update_traces(aaxis_separatethousands=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      If "True", even 4-digit integers are separated

    • tickformat
      Code: fig.update_traces(aaxis_tickformat=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      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: 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"

    • tickformatstops
      Code: fig.update_traces(aaxis_tickformatstops=list(...), selector=dict(type='carpet'))
      Type: list of dict where each dict has one or more of the keys listed below.
      • enabled
        Parent: data[type=carpet].aaxis.tickformatstops[]
        Type: boolean
        Default: True

        Determines whether or not this stop is used. If `False`, this stop is ignored even within its `dtickrange`.

      • dtickrange
        Parent: data[type=carpet].aaxis.tickformatstops[]
        Type: list

        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"

      • value
        Parent: data[type=carpet].aaxis.tickformatstops[]
        Type: string
        Default: ""

        string - dtickformat for described zoom level, the same as "tickformat"

      • name
        Parent: data[type=carpet].aaxis.tickformatstops[]
        Type: string

        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.

      • templateitemname
        Parent: data[type=carpet].aaxis.tickformatstops[]
        Type: string

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

    • categoryorder
      Code: fig.update_traces(aaxis_categoryorder=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" )
      Default: "trace"

      Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.

    • categoryarray
      Code: fig.update_traces(aaxis_categoryarray=<VALUE>, selector=dict(type='carpet'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

      Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

    • labelpadding
      Code: fig.update_traces(aaxis_labelpadding=<VALUE>, selector=dict(type='carpet'))
      Type: integer
      Default: 10

      Extra padding between label and the axis

    • labelprefix
      Code: fig.update_traces(aaxis_labelprefix=<VALUE>, selector=dict(type='carpet'))
      Type: string

      Sets a axis label prefix.

    • labelsuffix
      Code: fig.update_traces(aaxis_labelsuffix=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      Sets a axis label suffix.

    • showline
      Code: fig.update_traces(aaxis_showline=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not a line bounding this axis is drawn.

    • linecolor
      Code: fig.update_traces(aaxis_linecolor=<VALUE>, selector=dict(type='carpet'))
      Type: color
      Default: "#444"

      Sets the axis line color.

    • linewidth
      Code: fig.update_traces(aaxis_linewidth=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • gridcolor
      Code: fig.update_traces(aaxis_gridcolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the axis line color.

    • gridwidth
      Code: fig.update_traces(aaxis_gridwidth=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • showgrid
      Code: fig.update_traces(aaxis_showgrid=<VALUE>, selector=dict(type='carpet'))
      Type: boolean
      Default: True

      Determines whether or not grid lines are drawn. If "True", the grid lines are drawn at every tick mark.

    • minorgridcount
      Code: fig.update_traces(aaxis_minorgridcount=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 0
      Default: 0

      Sets the number of minor grid ticks per major grid tick

    • minorgridwidth
      Code: fig.update_traces(aaxis_minorgridwidth=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the grid lines.

    • minorgridcolor
      Code: fig.update_traces(aaxis_minorgridcolor=<VALUE>, selector=dict(type='carpet'))
      Type: color
      Default: "#eee"

      Sets the color of the grid lines.

    • startline
      Code: fig.update_traces(aaxis_startline=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not a line is drawn at along the starting value of this axis. If "True", the start line is drawn on top of the grid lines.

    • startlinecolor
      Code: fig.update_traces(aaxis_startlinecolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the line color of the start line.

    • startlinewidth
      Code: fig.update_traces(aaxis_startlinewidth=<VALUE>, selector=dict(type='carpet'))
      Type: number
      Default: 1

      Sets the width (in px) of the start line.

    • endline
      Code: fig.update_traces(aaxis_endline=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not a line is drawn at along the final value of this axis. If "True", the end line is drawn on top of the grid lines.

    • endlinewidth
      Code: fig.update_traces(aaxis_endlinewidth=<VALUE>, selector=dict(type='carpet'))
      Type: number
      Default: 1

      Sets the width (in px) of the end line.

    • endlinecolor
      Code: fig.update_traces(aaxis_endlinecolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the line color of the end line.

    • tick0
      Code: fig.update_traces(aaxis_tick0=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • dtick
      Code: fig.update_traces(aaxis_dtick=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      The stride between grid lines along the axis

    • arraytick0
      Code: fig.update_traces(aaxis_arraytick0=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • arraydtick
      Code: fig.update_traces(aaxis_arraydtick=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 1
      Default: 1

      The stride between grid lines along the axis

  • baxis
    Code: fig.update_traces(baxis=dict(...), selector=dict(type='carpet'))
    Type: dict containing one or more of the keys listed below.
    • color
      Code: fig.update_traces(baxis_color=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

    • smoothing
      Code: fig.update_traces(baxis_smoothing=<VALUE>, selector=dict(type='carpet'))
      Type: number between or equal to 0 and 1.3
      Default: 1
    • title
      Code: fig.update_traces(baxis_title=dict(...), selector=dict(type='carpet'))
      Type: dict containing one or more of the keys listed below.
      • text
        Code: fig.update_traces(baxis_title_text=<VALUE>, selector=dict(type='carpet'))
        Type: string
        Default: ""

        Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

      • font
        Code: fig.update_traces(baxis_title_font=dict(...), selector=dict(type='carpet'))
        Type: dict containing one or more of the keys listed below.

        Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

        • family
          Code: fig.update_traces(baxis_title_font_family=<VALUE>, selector=dict(type='carpet'))
          Type: string

          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

        • size
          Code: fig.update_traces(baxis_title_font_size=<VALUE>, selector=dict(type='carpet'))
          Type: number greater than or equal to 1
        • color
          Code: fig.update_traces(baxis_title_font_color=<VALUE>, selector=dict(type='carpet'))
          Type: color
      • offset
        Code: fig.update_traces(baxis_title_offset=<VALUE>, selector=dict(type='carpet'))
        Type: number
        Default: 10

        An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute.

    • type
      Code: fig.update_traces(baxis_type=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "-" | "linear" | "date" | "category" )
      Default: "-"

      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

    • autorange
      Code: fig.update_traces(baxis_autorange=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( True | False | "reversed" )
      Default: True

      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "False".

    • rangemode
      Code: fig.update_traces(baxis_rangemode=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "normal" | "tozero" | "nonnegative" )
      Default: "normal"

      If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.

    • range
      Code: fig.update_traces(baxis_range=<VALUE>, selector=dict(type='carpet'))
      Type: list

      Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

    • fixedrange
      Code: fig.update_traces(baxis_fixedrange=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not this axis is zoom-able. If True, then zoom is disabled.

    • cheatertype
      Code: fig.update_traces(baxis_cheatertype=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "index" | "value" )
      Default: "value"
    • tickmode
      Code: fig.update_traces(baxis_tickmode=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "linear" | "array" )
      Default: "array"
    • nticks
      Code: fig.update_traces(baxis_nticks=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 0
      Default: 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".

    • tickvals
      Code: fig.update_traces(baxis_tickvals=<VALUE>, selector=dict(type='carpet'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

    • ticktext
      Code: fig.update_traces(baxis_ticktext=<VALUE>, selector=dict(type='carpet'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

    • showticklabels
      Code: fig.update_traces(baxis_showticklabels=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "start" | "end" | "both" | "none" )
      Default: "start"

      Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

    • tickfont
      Code: fig.update_traces(baxis_tickfont=dict(...), selector=dict(type='carpet'))
      Type: dict containing one or more of the keys listed below.

      Sets the tick font.

      • family
        Code: fig.update_traces(baxis_tickfont_family=<VALUE>, selector=dict(type='carpet'))
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

      • size
        Code: fig.update_traces(baxis_tickfont_size=<VALUE>, selector=dict(type='carpet'))
        Type: number greater than or equal to 1
      • color
        Code: fig.update_traces(baxis_tickfont_color=<VALUE>, selector=dict(type='carpet'))
        Type: color
    • tickangle
      Code: fig.update_traces(baxis_tickangle=<VALUE>, selector=dict(type='carpet'))
      Type: angle
      Default: "auto"

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

    • tickprefix
      Code: fig.update_traces(baxis_tickprefix=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      Sets a tick label prefix.

    • showtickprefix
      Code: fig.update_traces(baxis_showtickprefix=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "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.

    • ticksuffix
      Code: fig.update_traces(baxis_ticksuffix=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      Sets a tick label suffix.

    • showticksuffix
      Code: fig.update_traces(baxis_showticksuffix=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • showexponent
      Code: fig.update_traces(baxis_showexponent=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "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.

    • exponentformat
      Code: fig.update_traces(baxis_exponentformat=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
      Default: "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.

    • minexponent
      Code: fig.update_traces(baxis_minexponent=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 3

      Hide SI prefix for 10^n if |n| is below this number

    • separatethousands
      Code: fig.update_traces(baxis_separatethousands=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      If "True", even 4-digit integers are separated

    • tickformat
      Code: fig.update_traces(baxis_tickformat=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      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: 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"

    • tickformatstops
      Code: fig.update_traces(baxis_tickformatstops=list(...), selector=dict(type='carpet'))
      Type: list of dict where each dict has one or more of the keys listed below.
      • enabled
        Parent: data[type=carpet].baxis.tickformatstops[]
        Type: boolean
        Default: True

        Determines whether or not this stop is used. If `False`, this stop is ignored even within its `dtickrange`.

      • dtickrange
        Parent: data[type=carpet].baxis.tickformatstops[]
        Type: list

        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"

      • value
        Parent: data[type=carpet].baxis.tickformatstops[]
        Type: string
        Default: ""

        string - dtickformat for described zoom level, the same as "tickformat"

      • name
        Parent: data[type=carpet].baxis.tickformatstops[]
        Type: string

        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.

      • templateitemname
        Parent: data[type=carpet].baxis.tickformatstops[]
        Type: string

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

    • categoryorder
      Code: fig.update_traces(baxis_categoryorder=<VALUE>, selector=dict(type='carpet'))
      Type: enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" )
      Default: "trace"

      Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.

    • categoryarray
      Code: fig.update_traces(baxis_categoryarray=<VALUE>, selector=dict(type='carpet'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

      Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

    • labelpadding
      Code: fig.update_traces(baxis_labelpadding=<VALUE>, selector=dict(type='carpet'))
      Type: integer
      Default: 10

      Extra padding between label and the axis

    • labelprefix
      Code: fig.update_traces(baxis_labelprefix=<VALUE>, selector=dict(type='carpet'))
      Type: string

      Sets a axis label prefix.

    • labelsuffix
      Code: fig.update_traces(baxis_labelsuffix=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""

      Sets a axis label suffix.

    • showline
      Code: fig.update_traces(baxis_showline=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not a line bounding this axis is drawn.

    • linecolor
      Code: fig.update_traces(baxis_linecolor=<VALUE>, selector=dict(type='carpet'))
      Type: color
      Default: "#444"

      Sets the axis line color.

    • linewidth
      Code: fig.update_traces(baxis_linewidth=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • gridcolor
      Code: fig.update_traces(baxis_gridcolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the axis line color.

    • gridwidth
      Code: fig.update_traces(baxis_gridwidth=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the axis line.

    • showgrid
      Code: fig.update_traces(baxis_showgrid=<VALUE>, selector=dict(type='carpet'))
      Type: boolean
      Default: True

      Determines whether or not grid lines are drawn. If "True", the grid lines are drawn at every tick mark.

    • minorgridcount
      Code: fig.update_traces(baxis_minorgridcount=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 0
      Default: 0

      Sets the number of minor grid ticks per major grid tick

    • minorgridwidth
      Code: fig.update_traces(baxis_minorgridwidth=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the grid lines.

    • minorgridcolor
      Code: fig.update_traces(baxis_minorgridcolor=<VALUE>, selector=dict(type='carpet'))
      Type: color
      Default: "#eee"

      Sets the color of the grid lines.

    • startline
      Code: fig.update_traces(baxis_startline=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not a line is drawn at along the starting value of this axis. If "True", the start line is drawn on top of the grid lines.

    • startlinecolor
      Code: fig.update_traces(baxis_startlinecolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the line color of the start line.

    • startlinewidth
      Code: fig.update_traces(baxis_startlinewidth=<VALUE>, selector=dict(type='carpet'))
      Type: number
      Default: 1

      Sets the width (in px) of the start line.

    • endline
      Code: fig.update_traces(baxis_endline=<VALUE>, selector=dict(type='carpet'))
      Type: boolean

      Determines whether or not a line is drawn at along the final value of this axis. If "True", the end line is drawn on top of the grid lines.

    • endlinewidth
      Code: fig.update_traces(baxis_endlinewidth=<VALUE>, selector=dict(type='carpet'))
      Type: number
      Default: 1

      Sets the width (in px) of the end line.

    • endlinecolor
      Code: fig.update_traces(baxis_endlinecolor=<VALUE>, selector=dict(type='carpet'))
      Type: color

      Sets the line color of the end line.

    • tick0
      Code: fig.update_traces(baxis_tick0=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • dtick
      Code: fig.update_traces(baxis_dtick=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 0
      Default: 1

      The stride between grid lines along the axis

    • arraytick0
      Code: fig.update_traces(baxis_arraytick0=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • arraydtick
      Code: fig.update_traces(baxis_arraydtick=<VALUE>, selector=dict(type='carpet'))
      Type: integer greater than or equal to 1
      Default: 1

      The stride between grid lines along the axis

  • xaxis
    Code: fig.update_traces(xaxis=<VALUE>, selector=dict(type='carpet'))
    Type: subplotid
    Default: x

    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.

  • yaxis
    Code: fig.update_traces(yaxis=<VALUE>, selector=dict(type='carpet'))
    Type: subplotid
    Default: y

    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.

  • color
    Code: fig.update_traces(color=<VALUE>, selector=dict(type='carpet'))
    Type: color
    Default: "#444"

    Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

  • carpet
    Code: fig.update_traces(carpet=<VALUE>, selector=dict(type='carpet'))
    Type: string

    An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie

  • cheaterslope
    Code: fig.update_traces(cheaterslope=<VALUE>, selector=dict(type='carpet'))
    Type: number
    Default: 1

    The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been ommitted.

  • font
    Code: fig.update_traces(font=dict(...), selector=dict(type='carpet'))
    Type: dict containing one or more of the keys listed below.

    The default font used for axis & tick labels on this carpet

    • family
      Code: fig.update_traces(font_family=<VALUE>, selector=dict(type='carpet'))
      Type: string
      Default: ""Open Sans", verdana, arial, sans-serif"

      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

    • size
      Code: fig.update_traces(font_size=<VALUE>, selector=dict(type='carpet'))
      Type: number greater than or equal to 1
      Default: 12
    • color
      Code: fig.update_traces(font_color=<VALUE>, selector=dict(type='carpet'))
      Type: color
      Default: "#444"
  • uirevision
    Code: fig.update_traces(uirevision=<VALUE>, selector=dict(type='carpet'))
    Type: number or categorical coordinate string

    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.