MATLAB Figure Reference: carpet Traces

A carpet trace is a struct inside fig.data which has type equal to 'carpet'. This section lists all of the valid keys that a carpet struct can contain.

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

  • type
    Parent: data[type=carpet]
    Type: 'carpet'
  • name
    Parent: data[type=carpet]
    Type: string

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

  • visible
    Parent: data[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).

  • legend
    Parent: data[type=carpet]
    Type: subplotid
    Default: 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.

  • legendrank
    Parent: data[type=carpet]
    Type: number
    Default: 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.

  • legendgrouptitle
    Parent: data[type=carpet]
    Type: struct containing one or more of the keys listed below.
    • font
      Parent: data[type=carpet].legendgrouptitle
      Type: struct containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Parent: data[type=carpet].legendgrouptitle.font
        Type: color
      • family
        Parent: data[type=carpet].legendgrouptitle.font
        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'.

      • lineposition
        Parent: data[type=carpet].legendgrouptitle.font
        Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
        Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
        Default: '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.

      • shadow
        Parent: data[type=carpet].legendgrouptitle.font
        Type: string
        Default: '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.

      • size
        Parent: data[type=carpet].legendgrouptitle.font
        Type: number greater than or equal to 1
      • style
        Parent: data[type=carpet].legendgrouptitle.font
        Type: enumerated , one of ( 'normal' | 'italic' )
        Default: 'normal'

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Parent: data[type=carpet].legendgrouptitle.font
        Type: enumerated , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
        Default: 'normal'

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Parent: data[type=carpet].legendgrouptitle.font
        Type: enumerated , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
        Default: 'normal'

        Sets the variant of the font.

      • weight
        Parent: data[type=carpet].legendgrouptitle.font
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Parent: data[type=carpet].legendgrouptitle
      Type: string
      Default: ''

      Sets the title of the legend group.

  • legendwidth
    Parent: data[type=carpet]
    Type: number greater than or equal to 0

    Sets the width (in px or fraction) of the legend for this trace.

  • opacity
    Parent: data[type=carpet]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=carpet]
    Type: array

    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.

  • zorder
    Parent: data[type=carpet]
    Type: integer
    Default: 0

    Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.

  • x
    Parent: data[type=carpet]
    Type: array

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

  • y
    Parent: data[type=carpet]
    Type: array

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

  • a
    Parent: data[type=carpet]
    Type: array

    An array containing values of the first parameter value

  • a0
    Parent: data[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
    Parent: data[type=carpet]
    Type: number
    Default: 1

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

  • b
    Parent: data[type=carpet]
    Type: array

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

  • b0
    Parent: data[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
    Parent: data[type=carpet]
    Type: number
    Default: 1

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

  • meta
    Parent: data[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
    Parent: data[type=carpet]
    Type: array

    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
    Parent: data[type=carpet]
    Type: struct containing one or more of the keys listed below.
    • arraydtick
      Parent: data[type=carpet].aaxis
      Type: integer greater than or equal to 1
      Default: 1

      The stride between grid lines along the axis

    • arraytick0
      Parent: data[type=carpet].aaxis
      Type: integer greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • autorange
      Parent: data[type=carpet].aaxis
      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'.

    • autotypenumbers
      Parent: data[type=carpet].aaxis
      Type: enumerated , one of ( 'convert types' | 'strict' )
      Default: 'convert types'

      Using 'strict' a numeric string in trace data is not converted to a number. Using 'convert types' a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.

    • categoryarray
      Parent: data[type=carpet].aaxis
      Type: array

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

    • categoryorder
      Parent: data[type=carpet].aaxis
      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`.

    • cheatertype
      Parent: data[type=carpet].aaxis
      Type: enumerated , one of ( 'index' | 'value' )
      Default: 'value'
    • color
      Parent: data[type=carpet].aaxis
      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.

    • dtick
      Parent: data[type=carpet].aaxis
      Type: number greater than or equal to 0
      Default: 1

      The stride between grid lines along the axis

    • endline
      Parent: data[type=carpet].aaxis
      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.

    • endlinecolor
      Parent: data[type=carpet].aaxis
      Type: color

      Sets the line color of the end line.

    • endlinewidth
      Parent: data[type=carpet].aaxis
      Type: number
      Default: 1

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

    • exponentformat
      Parent: data[type=carpet].aaxis
      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.

    • fixedrange
      Parent: data[type=carpet].aaxis
      Type: boolean

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

    • gridcolor
      Parent: data[type=carpet].aaxis
      Type: color

      Sets the axis line color.

    • griddash
      Parent: data[type=carpet].aaxis
      Type: string
      Default: 'solid'

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

    • gridwidth
      Parent: data[type=carpet].aaxis
      Type: number greater than or equal to 0
      Default: 1

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

    • labelalias
      Parent: data[type=carpet].aaxis
      Type: number or categorical coordinate string

      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.

    • labelpadding
      Parent: data[type=carpet].aaxis
      Type: integer
      Default: 10

      Extra padding between label and the axis

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

      Sets a axis label prefix.

    • labelsuffix
      Parent: data[type=carpet].aaxis
      Type: string
      Default: ''

      Sets a axis label suffix.

    • linecolor
      Parent: data[type=carpet].aaxis
      Type: color
      Default: '#444'

      Sets the axis line color.

    • linewidth
      Parent: data[type=carpet].aaxis
      Type: number greater than or equal to 0
      Default: 1

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

    • minexponent
      Parent: data[type=carpet].aaxis
      Type: number greater than or equal to 0
      Default: 3

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

    • minorgridcolor
      Parent: data[type=carpet].aaxis
      Type: color
      Default: '#eee'

      Sets the color of the grid lines.

    • minorgridcount
      Parent: data[type=carpet].aaxis
      Type: integer greater than or equal to 0
      Default: 0

      Sets the number of minor grid ticks per major grid tick

    • minorgriddash
      Parent: data[type=carpet].aaxis
      Type: string
      Default: 'solid'

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

    • minorgridwidth
      Parent: data[type=carpet].aaxis
      Type: number greater than or equal to 0
      Default: 1

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

    • nticks
      Parent: data[type=carpet].aaxis
      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'.

    • range
      Parent: data[type=carpet].aaxis
      Type: cell array

      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.

    • rangemode
      Parent: data[type=carpet].aaxis
      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.

    • separatethousands
      Parent: data[type=carpet].aaxis
      Type: boolean

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

    • showexponent
      Parent: data[type=carpet].aaxis
      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.

    • showgrid
      Parent: data[type=carpet].aaxis
      Type: boolean
      Default: true

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

    • showline
      Parent: data[type=carpet].aaxis
      Type: boolean

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

    • showticklabels
      Parent: data[type=carpet].aaxis
      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.

    • showtickprefix
      Parent: data[type=carpet].aaxis
      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.

    • showticksuffix
      Parent: data[type=carpet].aaxis
      Type: enumerated , one of ( 'all' | 'first' | 'last' | 'none' )
      Default: 'all'

      Same as `showtickprefix` but for tick suffixes.

    • smoothing
      Parent: data[type=carpet].aaxis
      Type: number between or equal to 0 and 1.3
      Default: 1
    • startline
      Parent: data[type=carpet].aaxis
      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
      Parent: data[type=carpet].aaxis
      Type: color

      Sets the line color of the start line.

    • startlinewidth
      Parent: data[type=carpet].aaxis
      Type: number
      Default: 1

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

    • tick0
      Parent: data[type=carpet].aaxis
      Type: number greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • tickangle
      Parent: data[type=carpet].aaxis
      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.

    • tickfont
      Parent: data[type=carpet].aaxis
      Type: struct containing one or more of the keys listed below.

      Sets the tick font.

      • color
        Parent: data[type=carpet].aaxis.tickfont
        Type: color
      • family
        Parent: data[type=carpet].aaxis.tickfont
        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'.

      • lineposition
        Parent: data[type=carpet].aaxis.tickfont
        Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
        Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
        Default: '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.

      • shadow
        Parent: data[type=carpet].aaxis.tickfont
        Type: string
        Default: '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.

      • size
        Parent: data[type=carpet].aaxis.tickfont
        Type: number greater than or equal to 1
      • style
        Parent: data[type=carpet].aaxis.tickfont
        Type: enumerated , one of ( 'normal' | 'italic' )
        Default: 'normal'

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Parent: data[type=carpet].aaxis.tickfont
        Type: enumerated , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
        Default: 'normal'

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Parent: data[type=carpet].aaxis.tickfont
        Type: enumerated , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
        Default: 'normal'

        Sets the variant of the font.

      • weight
        Parent: data[type=carpet].aaxis.tickfont
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • tickformat
      Parent: data[type=carpet].aaxis
      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-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'

    • tickformatstops
      Parent: data[type=carpet].aaxis
      Type: cell array of struct where each struct has one or more of the keys listed below.
      • dtickrange
        Parent: data[type=carpet].aaxis.tickformatstops[]
        Type: cell array

        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'

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

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

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

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

    • tickmode
      Parent: data[type=carpet].aaxis
      Type: enumerated , one of ( 'linear' | 'array' )
      Default: 'array'
    • tickprefix
      Parent: data[type=carpet].aaxis
      Type: string
      Default: ''

      Sets a tick label prefix.

    • ticksuffix
      Parent: data[type=carpet].aaxis
      Type: string
      Default: ''

      Sets a tick label suffix.

    • ticktext
      Parent: data[type=carpet].aaxis
      Type: array

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

    • tickvals
      Parent: data[type=carpet].aaxis
      Type: array

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

    • title
      Parent: data[type=carpet].aaxis
      Type: struct containing one or more of the keys listed below.
      • font
        Parent: data[type=carpet].aaxis.title
        Type: struct 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.

        • color
          Parent: data[type=carpet].aaxis.title.font
          Type: color
        • family
          Parent: data[type=carpet].aaxis.title.font
          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'.

        • lineposition
          Parent: data[type=carpet].aaxis.title.font
          Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
          Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
          Default: '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.

        • shadow
          Parent: data[type=carpet].aaxis.title.font
          Type: string
          Default: '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.

        • size
          Parent: data[type=carpet].aaxis.title.font
          Type: number greater than or equal to 1
        • style
          Parent: data[type=carpet].aaxis.title.font
          Type: enumerated , one of ( 'normal' | 'italic' )
          Default: 'normal'

          Sets whether a font should be styled with a normal or italic face from its family.

        • textcase
          Parent: data[type=carpet].aaxis.title.font
          Type: enumerated , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
          Default: 'normal'

          Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

        • variant
          Parent: data[type=carpet].aaxis.title.font
          Type: enumerated , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
          Default: 'normal'

          Sets the variant of the font.

        • weight
          Parent: data[type=carpet].aaxis.title.font
          Type: integer between or equal to 1 and 1000
          Default: normal

          Sets the weight (or boldness) of the font.

      • offset
        Parent: data[type=carpet].aaxis.title
        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.

      • text
        Parent: data[type=carpet].aaxis.title
        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.

    • type
      Parent: data[type=carpet].aaxis
      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.

  • baxis
    Parent: data[type=carpet]
    Type: struct containing one or more of the keys listed below.
    • arraydtick
      Parent: data[type=carpet].baxis
      Type: integer greater than or equal to 1
      Default: 1

      The stride between grid lines along the axis

    • arraytick0
      Parent: data[type=carpet].baxis
      Type: integer greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • autorange
      Parent: data[type=carpet].baxis
      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'.

    • autotypenumbers
      Parent: data[type=carpet].baxis
      Type: enumerated , one of ( 'convert types' | 'strict' )
      Default: 'convert types'

      Using 'strict' a numeric string in trace data is not converted to a number. Using 'convert types' a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.

    • categoryarray
      Parent: data[type=carpet].baxis
      Type: array

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

    • categoryorder
      Parent: data[type=carpet].baxis
      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`.

    • cheatertype
      Parent: data[type=carpet].baxis
      Type: enumerated , one of ( 'index' | 'value' )
      Default: 'value'
    • color
      Parent: data[type=carpet].baxis
      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.

    • dtick
      Parent: data[type=carpet].baxis
      Type: number greater than or equal to 0
      Default: 1

      The stride between grid lines along the axis

    • endline
      Parent: data[type=carpet].baxis
      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.

    • endlinecolor
      Parent: data[type=carpet].baxis
      Type: color

      Sets the line color of the end line.

    • endlinewidth
      Parent: data[type=carpet].baxis
      Type: number
      Default: 1

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

    • exponentformat
      Parent: data[type=carpet].baxis
      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.

    • fixedrange
      Parent: data[type=carpet].baxis
      Type: boolean

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

    • gridcolor
      Parent: data[type=carpet].baxis
      Type: color

      Sets the axis line color.

    • griddash
      Parent: data[type=carpet].baxis
      Type: string
      Default: 'solid'

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

    • gridwidth
      Parent: data[type=carpet].baxis
      Type: number greater than or equal to 0
      Default: 1

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

    • labelalias
      Parent: data[type=carpet].baxis
      Type: number or categorical coordinate string

      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.

    • labelpadding
      Parent: data[type=carpet].baxis
      Type: integer
      Default: 10

      Extra padding between label and the axis

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

      Sets a axis label prefix.

    • labelsuffix
      Parent: data[type=carpet].baxis
      Type: string
      Default: ''

      Sets a axis label suffix.

    • linecolor
      Parent: data[type=carpet].baxis
      Type: color
      Default: '#444'

      Sets the axis line color.

    • linewidth
      Parent: data[type=carpet].baxis
      Type: number greater than or equal to 0
      Default: 1

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

    • minexponent
      Parent: data[type=carpet].baxis
      Type: number greater than or equal to 0
      Default: 3

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

    • minorgridcolor
      Parent: data[type=carpet].baxis
      Type: color
      Default: '#eee'

      Sets the color of the grid lines.

    • minorgridcount
      Parent: data[type=carpet].baxis
      Type: integer greater than or equal to 0
      Default: 0

      Sets the number of minor grid ticks per major grid tick

    • minorgriddash
      Parent: data[type=carpet].baxis
      Type: string
      Default: 'solid'

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

    • minorgridwidth
      Parent: data[type=carpet].baxis
      Type: number greater than or equal to 0
      Default: 1

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

    • nticks
      Parent: data[type=carpet].baxis
      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'.

    • range
      Parent: data[type=carpet].baxis
      Type: cell array

      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.

    • rangemode
      Parent: data[type=carpet].baxis
      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.

    • separatethousands
      Parent: data[type=carpet].baxis
      Type: boolean

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

    • showexponent
      Parent: data[type=carpet].baxis
      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.

    • showgrid
      Parent: data[type=carpet].baxis
      Type: boolean
      Default: true

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

    • showline
      Parent: data[type=carpet].baxis
      Type: boolean

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

    • showticklabels
      Parent: data[type=carpet].baxis
      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.

    • showtickprefix
      Parent: data[type=carpet].baxis
      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.

    • showticksuffix
      Parent: data[type=carpet].baxis
      Type: enumerated , one of ( 'all' | 'first' | 'last' | 'none' )
      Default: 'all'

      Same as `showtickprefix` but for tick suffixes.

    • smoothing
      Parent: data[type=carpet].baxis
      Type: number between or equal to 0 and 1.3
      Default: 1
    • startline
      Parent: data[type=carpet].baxis
      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
      Parent: data[type=carpet].baxis
      Type: color

      Sets the line color of the start line.

    • startlinewidth
      Parent: data[type=carpet].baxis
      Type: number
      Default: 1

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

    • tick0
      Parent: data[type=carpet].baxis
      Type: number greater than or equal to 0
      Default: 0

      The starting index of grid lines along the axis

    • tickangle
      Parent: data[type=carpet].baxis
      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.

    • tickfont
      Parent: data[type=carpet].baxis
      Type: struct containing one or more of the keys listed below.

      Sets the tick font.

      • color
        Parent: data[type=carpet].baxis.tickfont
        Type: color
      • family
        Parent: data[type=carpet].baxis.tickfont
        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'.

      • lineposition
        Parent: data[type=carpet].baxis.tickfont
        Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
        Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
        Default: '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.

      • shadow
        Parent: data[type=carpet].baxis.tickfont
        Type: string
        Default: '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.

      • size
        Parent: data[type=carpet].baxis.tickfont
        Type: number greater than or equal to 1
      • style
        Parent: data[type=carpet].baxis.tickfont
        Type: enumerated , one of ( 'normal' | 'italic' )
        Default: 'normal'

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Parent: data[type=carpet].baxis.tickfont
        Type: enumerated , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
        Default: 'normal'

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Parent: data[type=carpet].baxis.tickfont
        Type: enumerated , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
        Default: 'normal'

        Sets the variant of the font.

      • weight
        Parent: data[type=carpet].baxis.tickfont
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • tickformat
      Parent: data[type=carpet].baxis
      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-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'

    • tickformatstops
      Parent: data[type=carpet].baxis
      Type: cell array of struct where each struct has one or more of the keys listed below.
      • dtickrange
        Parent: data[type=carpet].baxis.tickformatstops[]
        Type: cell array

        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'

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

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

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

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

    • tickmode
      Parent: data[type=carpet].baxis
      Type: enumerated , one of ( 'linear' | 'array' )
      Default: 'array'
    • tickprefix
      Parent: data[type=carpet].baxis
      Type: string
      Default: ''

      Sets a tick label prefix.

    • ticksuffix
      Parent: data[type=carpet].baxis
      Type: string
      Default: ''

      Sets a tick label suffix.

    • ticktext
      Parent: data[type=carpet].baxis
      Type: array

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

    • tickvals
      Parent: data[type=carpet].baxis
      Type: array

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

    • title
      Parent: data[type=carpet].baxis
      Type: struct containing one or more of the keys listed below.
      • font
        Parent: data[type=carpet].baxis.title
        Type: struct 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.

        • color
          Parent: data[type=carpet].baxis.title.font
          Type: color
        • family
          Parent: data[type=carpet].baxis.title.font
          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'.

        • lineposition
          Parent: data[type=carpet].baxis.title.font
          Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
          Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
          Default: '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.

        • shadow
          Parent: data[type=carpet].baxis.title.font
          Type: string
          Default: '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.

        • size
          Parent: data[type=carpet].baxis.title.font
          Type: number greater than or equal to 1
        • style
          Parent: data[type=carpet].baxis.title.font
          Type: enumerated , one of ( 'normal' | 'italic' )
          Default: 'normal'

          Sets whether a font should be styled with a normal or italic face from its family.

        • textcase
          Parent: data[type=carpet].baxis.title.font
          Type: enumerated , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
          Default: 'normal'

          Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

        • variant
          Parent: data[type=carpet].baxis.title.font
          Type: enumerated , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
          Default: 'normal'

          Sets the variant of the font.

        • weight
          Parent: data[type=carpet].baxis.title.font
          Type: integer between or equal to 1 and 1000
          Default: normal

          Sets the weight (or boldness) of the font.

      • offset
        Parent: data[type=carpet].baxis.title
        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.

      • text
        Parent: data[type=carpet].baxis.title
        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.

    • type
      Parent: data[type=carpet].baxis
      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.

  • xaxis
    Parent: data[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
    Parent: data[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
    Parent: data[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
    Parent: data[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
    Parent: data[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 omitted.

  • font
    Parent: data[type=carpet]
    Type: struct containing one or more of the keys listed below.

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

    • color
      Parent: data[type=carpet].font
      Type: color
      Default: '#444'
    • family
      Parent: data[type=carpet].font
      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'.

    • lineposition
      Parent: data[type=carpet].font
      Type: flaglist string. Any combination of 'under', 'over', 'through' joined with a '+' OR 'none'.
      Examples: 'under', 'over', 'under+over', 'under+over+through', 'none'
      Default: '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.

    • shadow
      Parent: data[type=carpet].font
      Type: string
      Default: '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.

    • size
      Parent: data[type=carpet].font
      Type: number greater than or equal to 1
      Default: 12
    • style
      Parent: data[type=carpet].font
      Type: enumerated , one of ( 'normal' | 'italic' )
      Default: 'normal'

      Sets whether a font should be styled with a normal or italic face from its family.

    • textcase
      Parent: data[type=carpet].font
      Type: enumerated , one of ( 'normal' | 'word caps' | 'upper' | 'lower' )
      Default: 'normal'

      Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

    • variant
      Parent: data[type=carpet].font
      Type: enumerated , one of ( 'normal' | 'small-caps' | 'all-small-caps' | 'all-petite-caps' | 'petite-caps' | 'unicase' )
      Default: 'normal'

      Sets the variant of the font.

    • weight
      Parent: data[type=carpet].font
      Type: integer between or equal to 1 and 1000
      Default: normal

      Sets the weight (or boldness) of the font.

  • uirevision
    Parent: data[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.