plotly.graph_objects.layout.xaxis.rangeselector package

class plotly.graph_objects.layout.xaxis.rangeselector.Button(arg=None, count=None, label=None, name=None, step=None, stepmode=None, templateitemname=None, visible=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property count

Sets the number of steps to take to update the range. Use with step to specify the update interval.

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

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

Returns

Return type

int|float

property label

Sets the text label to appear on the button.

The ‘label’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property name

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.

The ‘name’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property step

The unit of measurement that the count value will set the range by.

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

    [‘month’, ‘year’, ‘day’, ‘hour’, ‘minute’, ‘second’, ‘all’]

Returns

Return type

Any

property stepmode

Sets the range update mode. If “backward”, the range update shifts the start of range back “count” times “step” milliseconds. If “todate”, the range update shifts the start of range back to the first timestamp from “count” times “step” milliseconds back. For example, with step set to “year” and count set to 1 the range update shifts the start of the range back to January 01 of the current year. Month and year “todate” are currently available only for the built-in (Gregorian) calendar.

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

    [‘backward’, ‘todate’]

Returns

Return type

Any

property templateitemname

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.

The ‘templateitemname’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property visible

Determines whether or not this button is visible.

The ‘visible’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

class plotly.graph_objects.layout.xaxis.rangeselector.Font(arg=None, color=None, family=None, size=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property color
The ‘color’ 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:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns

Return type

str

property family

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

The ‘family’ property is a string and must be specified as:

  • A non-empty string

Returns

Return type

str

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

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

Returns

Return type

int|float