plotly.graph_objects.scatterpolargl.marker package

class plotly.graph_objects.scatterpolargl.marker.ColorBar(arg=None, bgcolor=None, bordercolor=None, borderwidth=None, dtick=None, exponentformat=None, labelalias=None, len=None, lenmode=None, minexponent=None, nticks=None, orientation=None, outlinecolor=None, outlinewidth=None, separatethousands=None, showexponent=None, showticklabels=None, showtickprefix=None, showticksuffix=None, thickness=None, thicknessmode=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklabeloverflow=None, ticklabelposition=None, ticklabelstep=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, ticksuffix=None, ticktext=None, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, x=None, xanchor=None, xpad=None, xref=None, y=None, yanchor=None, ypad=None, yref=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property bgcolor

Sets the color of padded area.

The ‘bgcolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property bordercolor

Sets the axis line color.

The ‘bordercolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property borderwidth

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

The ‘borderwidth’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property dtick

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”

The ‘dtick’ property accepts values of any type

Returns

Return type

Any

property exponentformat

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. “SI” uses prefixes from “femto” f (10^-15) to “tera” T (10^12). SI extended covers instead the full SI range from “quecto” q (10^-30) to “quetta” Q (10^30). If “SI” or SI extended is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.

The ‘exponentformat’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’, ‘SI extended’]

Returns

Return type

Any

property labelalias

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.

The ‘labelalias’ property accepts values of any type

Returns

Return type

Any

property len

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.

The ‘len’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property lenmode

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.

The ‘lenmode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘fraction’, ‘pixels’]

Returns

Return type

Any

property minexponent

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

The ‘minexponent’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property nticks

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

The ‘nticks’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property orientation

Sets the orientation of the colorbar.

The ‘orientation’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘h’, ‘v’]

Returns

Return type

Any

property outlinecolor

Sets the axis line color.

The ‘outlinecolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color: see https://plotly.com/python/css-colors/ for a list

Returns

Return type

str

property outlinewidth

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

The ‘outlinewidth’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property separatethousands

If “true”, even 4-digit integers are separated

The ‘separatethousands’ property is a boolean and must be specified as:

  • A boolean value: True or False

Returns

Return type

bool

property showexponent

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.

The ‘showexponent’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘all’, ‘first’, ‘last’, ‘none’]

Returns

Return type

Any

property showticklabels

Determines whether or not the tick labels are drawn.

The ‘showticklabels’ property is a boolean and must be specified as:

  • A boolean value: True or False

Returns