Color Bar
Color Bar Layout
Colorbar Bg Color
Default Value: rgba(0,0,0,0)
Type: color
Documentation: Sets the color of padded area.
Path: data.index.marker.colorbar.bgcolor
Colorbar Border Color
Default Value: #444
Type: color
Documentation: Sets the axis line color.
Path: data.index.marker.colorbar.bordercolor
Colorbar Border Width
Default Value: 0
Type: number
Min: 0
Documentation: Sets the width (in px) or the border enclosing this color bar.
Path: data.index.marker.colorbar.borderwidth
Colorbar Len
Default Value: 1
Type: number
Min: 0
Documentation: 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.
Path: data.index.marker.colorbar.len
Colorbar Len Mode
Default Value: fraction
Type: enumerated
Enum Options: fraction,pixels
Documentation: 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.
Path: data.index.marker.colorbar.lenmode
Colorbar Outline Color
Default Value: #444
Type: color
Documentation: Sets the axis line color.
Path: data.index.marker.colorbar.outlinecolor
Colorbar Outline Width
Default Value: 1
Type: number
Min: 0
Documentation: Sets the width (in px) of the axis line.
Path: data.index.marker.colorbar.outlinewidth
Colorbar Thickness
Default Value: 30
Type: number
Min: 0
Documentation: Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
Path: data.index.marker.colorbar.thickness
Colorbar Thickness Mode
Default Value: pixels
Type: enumerated
Enum Options: fraction,pixels
Documentation: 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.
Path: data.index.marker.colorbar.thicknessmode
Color Bar Ticks Options
Colorbar D Tick
Type: any
Documentation: 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, 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 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
Path: data.index.marker.colorbar.dtick
Colorbar N Ticks
Default Value: 0
Type: integer
Min: 0
Documentation: 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.
Path: data.index.marker.colorbar.nticks
Colorbar Show Tick Labels
Default Value: true
Type: boolean
Documentation: Determines whether or not the tick labels are drawn.
Path: data.index.marker.colorbar.showticklabels
Colorbar Ticks
Default Value:
Type: enumerated
Enum Options: outside,inside,
Documentation: 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.
Path: data.index.marker.colorbar.ticks
Color Bar Positioning
Colorbar Orientation
Default Value: v
Type: enumerated
Enum Options: h,v
Documentation: Sets the orientation of the colorbar.
Path: data.index.marker.colorbar.orientation
Colorbar X
Type: number
Documentation: Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.
Path: data.index.marker.colorbar.x
Colorbar X Anchor
Type: enumerated
Enum Options: left,center,right
Documentation: Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.
Path: data.index.marker.colorbar.xanchor
Colorbar Y
Type: number
Documentation: Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.
Path: data.index.marker.colorbar.y
Colorbar Y Anchor
Type: enumerated
Enum Options: top,middle,bottom
Documentation: Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.
Path: data.index.marker.colorbar.yanchor
Color Bar Title Options
Title Side
Type: enumerated
Enum Options: right,top,bottom
Documentation: Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h. Note that the title's location used to be set by the now deprecated titleside attribute.
Path: data.index.marker.colorbar.title.side
Title Text
Type: string
Documentation: 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.
Path: data.index.marker.colorbar.title.text
Color Scale Options
Auto Color Scale
Default Value: true
Type: boolean
Documentation: Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. 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.
Path: data.index.marker.autocolorscale
C Auto
Default Value: true
Type: boolean
Documentation: Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.
Path: data.index.marker.cauto
C Max
Type: number
Documentation: Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.
Path: data.index.marker.cmax
C Mid
Type: number
Documentation: Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.
Path: data.index.marker.cmid
C Min
Type: number
Documentation: Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.
Path: data.index.marker.cmin
Color Scale
Type: colorscale
Documentation: Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. 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 marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
Path: data.index.marker.colorscale
Reverse Scale
Default Value: false
Type: boolean
Documentation: Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.
Path: data.index.marker.reversescale
Show Scale
Default Value: false
Type: boolean
Documentation: Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.
Path: data.index.marker.showscale
Last updated
Was this helpful?