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

JavaScript Figure Reference: layout.coloraxis

  • coloraxis
    Parent: layout
    Type: object containing one or more of the keys listed below.
    • cauto
      Parent: layout.coloraxis
      Type: boolean
      Default: true

      Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

    • cmin
      Parent: layout.coloraxis
      Type: number

      Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmax` must be set as well.

    • cmax
      Parent: layout.coloraxis
      Type: number

      Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmin` must be set as well.

    • cmid
      Parent: layout.coloraxis
      Type: number

      Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect when `cauto` is `false`.

    • colorscale
      Parent: layout.coloraxis
      Type: colorscale

      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`cmin` and `cmax`. 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.

    • autocolorscale
      Parent: layout.coloraxis
      Type: boolean
      Default: true

      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.

    • reversescale
      Parent: layout.coloraxis
      Type: boolean

      Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.

    • showscale
      Parent: layout.coloraxis
      Type: boolean
      Default: true

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

    • colorbar
      Parent: layout.coloraxis
      Type: object containing one or more of the keys listed below.
      • thicknessmode
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: number between or equal to -2 and 3
        Default: 1.02

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

      • xanchor
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: number greater than or equal to 0
        Default: 10

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

      • y
        Parent: layout.coloraxis.colorbar
        Type: number between or equal to -2 and 3
        Default: 0.5

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

      • yanchor
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: number greater than or equal to 0
        Default: 10

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

      • outlinecolor
        Parent: layout.coloraxis.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: layout.coloraxis.colorbar
        Type: number greater than or equal to 0
        Default: 1

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

      • bordercolor
        Parent: layout.coloraxis.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: layout.coloraxis.colorbar
        Type: number greater than or equal to 0
        Default: 0

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

      • bgcolor
        Parent: layout.coloraxis.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • tickmode
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: data array

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

      • ticktext
        Parent: layout.coloraxis.colorbar
        Type: data array

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

      • ticks
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: layout.coloraxis.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: layout.coloraxis.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: layout.coloraxis.colorbar
        Type: boolean
        Default: true

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: layout.coloraxis.colorbar
        Type: object containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: layout.coloraxis.colorbar.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".

        • size
          Parent: layout.coloraxis.colorbar.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: layout.coloraxis.colorbar.tickfont
          Type: color
      • tickangle
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: array of object where each object has one or more of the keys listed below.
        • enabled
          Parent: layout.coloraxis.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: layout.coloraxis.colorbar.tickformatstops[]
          Type: 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"

        • value
          Parent: layout.coloraxis.colorbar.tickformatstops[]
          Type: string
          Default: ""

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

        • name
          Parent: layout.coloraxis.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: layout.coloraxis.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
        Parent: layout.coloraxis.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: layout.coloraxis.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: layout.coloraxis.colorbar
        Type: boolean

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

      • exponentformat
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        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
        Parent: layout.coloraxis.colorbar
        Type: object containing one or more of the keys listed below.
        • text
          Parent: layout.coloraxis.colorbar.title
          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
          Parent: layout.coloraxis.colorbar.title
          Type: object 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
            Parent: layout.coloraxis.colorbar.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".

          • size
            Parent: layout.coloraxis.colorbar.title.font
            Type: number greater than or equal to 1
          • color
            Parent: layout.coloraxis.colorbar.title.font
            Type: color
        • side
          Parent: layout.coloraxis.colorbar.title
          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.