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

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

Sets the opacity of the trace.

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.

Sets the x coordinates.

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

Sets the x coordinate step. See `x0` for more info.

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

Sets the y coordinates.

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

Sets the y coordinate step. See `y0` for more info.

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

Sets the z data.

Sets the text elements associated with each z value.

Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

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.

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

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.

Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

• thicknessmode
  Code: fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='heatmapgl'))
  Type: enumerated , one of ( "fraction" | "pixels" )
  Default: "pixels"

  Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

• thickness
  Code: fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='heatmapgl'))
  Type: number greater than or equal to 0
  Default: 30

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

• lenmode
  Code: fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='heatmapgl'))
  Type: enumerated , one of ( "fraction" | "pixels" )
  Default: "fraction"

  Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

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

  Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

• x
  Code: fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='heatmapgl'))
  Type: number between or equal to -2 and 3
  Default: 1.02

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

• xanchor
  Code: fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='heatmapgl'))
  Type: enumerated , one of ( "left" | "center" | "right" )
  Default: "left"

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

• xpad
  Code: fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='heatmapgl'))
  Type: number greater than or equal to 0
  Default: 10

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

• y
  Code: fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='heatmapgl'))
  Type: number between or equal to -2 and 3
  Default: 0.5

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

• yanchor
  Code: fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='heatmapgl'))
  Type: enumerated , one of ( "top" | "middle" | "bottom" )
  Default: "middle"

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

• ypad
  Code: fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='heatmapgl'))
  Type: number greater than or equal to 0
  Default: 10

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

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

  Sets the axis line color.

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

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

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

  Sets the axis line color.

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

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

• bgcolor
  Code: fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='heatmapgl'))
  Type: color
  Default: "rgba(0,0,0,0)"

  Sets the color of padded area.

• tickmode
  Code: fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='heatmapgl'))
  Type: enumerated , one of ( "auto" | "linear" | "array" )

  Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

• nticks
  Code: fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='heatmapgl'))
  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".

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

  Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

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

  Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

• tickvals
  Code: fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='heatmapgl'))
  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(colorbar_ticktext=<VALUE>, selector=dict(type='heatmapgl'))
  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`.

• ticks
  Code: fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='heatmapgl'))
  Type: enumerated , one of ( "outside" | "inside" | "" )
  Default: ""

  Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

• ticklen
  Code: fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='heatmapgl'))
  Type: number greater than or equal to 0
  Default: 5

  Sets the tick length (in px).

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

  Sets the tick width (in px).

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

  Sets the tick color.

• showticklabels
  Code: fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='heatmapgl'))
  Type: boolean
  Default: True

  Determines whether or not the tick labels are drawn.

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

  Sets the color bar's tick label font

  • family
    Code: fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='heatmapgl'))
    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(colorbar_tickfont_size=<VALUE>, selector=dict(type='heatmapgl'))
    Type: number greater than or equal to 1
  • color
    Code: fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='heatmapgl'))
    Type: color
• tickangle
  Code: fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='heatmapgl'))
  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.

• tickformat
  Code: fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='heatmapgl'))
  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: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

• tickformatstops
  Code: fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='heatmapgl'))
  Type: list of dict where each dict has one or more of the keys listed below.
  • enabled
    Parent: data[type=heatmapgl].colorbar.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=heatmapgl].colorbar.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=heatmapgl].colorbar.tickformatstops[]
    Type: string
    Default: ""

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

  • name
    Parent: data[type=heatmapgl].colorbar.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=heatmapgl].colorbar.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`.

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

  Sets a tick label prefix.

• showtickprefix
  Code: fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='heatmapgl'))
  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(colorbar_ticksuffix=<VALUE>, selector=dict(type='heatmapgl'))
  Type: string
  Default: ""

  Sets a tick label suffix.

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

  Same as `showtickprefix` but for tick suffixes.

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

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

• exponentformat
  Code: fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='heatmapgl'))
  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(colorbar_minexponent=<VALUE>, selector=dict(type='heatmapgl'))
  Type: number greater than or equal to 0
  Default: 3

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

• showexponent
  Code: fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='heatmapgl'))
  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.

• title
  Code: fig.update_traces(colorbar_title=dict(...), selector=dict(type='heatmapgl'))
  Type: dict containing one or more of the keys listed below.
  • text
    Code: fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='heatmapgl'))
    Type: string

    Sets the title of the color bar. 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(colorbar_title_font=dict(...), selector=dict(type='heatmapgl'))
    Type: dict containing one or more of the keys listed below.

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

    • family
      Code: fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='heatmapgl'))
      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(colorbar_title_font_size=<VALUE>, selector=dict(type='heatmapgl'))
      Type: number greater than or equal to 1
    • color
      Code: fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='heatmapgl'))
      Type: color
  • side
    Code: fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='heatmapgl'))
    Type: enumerated , one of ( "right" | "top" | "bottom" )
    Default: "top"

    Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

Determines whether the colorscale is a default palette (`autocolorscale: True`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is True, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

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

Reverses the color mapping if True. If True, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.

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

Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.

Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `False`.

Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.

Picks a smoothing algorithm use to smooth `z` data.

• bgcolor
  Code: fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='heatmapgl'))
  Type: color or array of colors

  Sets the background color of the hover labels for this trace

• bordercolor
  Code: fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='heatmapgl'))
  Type: color or array of colors

  Sets the border color of the hover labels for this trace.

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

  Sets the font used in hover labels.

  • family
    Code: fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='heatmapgl'))
    Type: string or array of strings

    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(hoverlabel_font_size=<VALUE>, selector=dict(type='heatmapgl'))
    Type: number or array of numbers greater than or equal to 1
  • color
    Code: fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='heatmapgl'))
    Type: color or array of colors
• align
  Code: fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='heatmapgl'))
  Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
  Default: "auto"

  Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

• namelength
  Code: fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='heatmapgl'))
  Type: integer or array of integers greater than or equal to -1
  Default: 15

  Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

Transposes the z data.

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.