plotly.graph_objects.layout.slider.Currentvalue(arg=None, font=None, offset=None, prefix=None, suffix=None, visible=None, xanchor=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
font¶Sets the font of the current value label text.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.layout.slider.currentvalue.FontA dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
color
- 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”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
offset¶The amount of space, in pixels, between the current value label and the slider.
An int or float
int|float
prefix¶When currentvalue.visible is true, this sets the prefix of the label.
A string
A number that will be converted to a string
suffix¶When currentvalue.visible is true, this sets the suffix of the label.
A string
A number that will be converted to a string
visible¶Shows the currently-selected value above the slider.
The ‘visible’ property must be specified as a bool (either True, or False)
xanchor¶The alignment of the value readout relative to the length of the slider.
[‘left’, ‘center’, ‘right’]
Any
plotly.graph_objects.layout.slider.Font(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
color¶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%)’)
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
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”.
A non-empty string
lineposition¶Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
Any
shadow¶Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
A string
A number that will be converted to a string
size¶An int or float in the interval [1, inf]
int|float
style¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
Any
textcase¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
Any
variant¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
Any
plotly.graph_objects.layout.slider.Pad(arg=None, b=None, l=None, r=None, t=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
b¶The amount of padding (in px) along the bottom of the component.
An int or float
int|float
l¶The amount of padding (in px) on the left side of the component.
An int or float
int|float
r¶The amount of padding (in px) on the right side of the component.
An int or float
int|float
t¶The amount of padding (in px) along the top of the component.
An int or float
int|float
plotly.graph_objects.layout.slider.Step(arg=None, args=None, execute=None, label=None, method=None, name=None, templateitemname=None, value=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
args¶in method on slide.
The ‘args’ property is an info array that may be specified as:
a list or tuple of up to 3 elements where:
The ‘args[0]’ property accepts values of any type
The ‘args[1]’ property accepts values of any type
The ‘args[2]’ property accepts values of any type
list
execute¶When true, the API method is executed. When false, all other
behaviors are the same and command execution is skipped. This
may be useful when hooking into, for example, the
plotly_sliderchange method and executing the API command
manually without losing the benefit of the slider automatically
binding to the state of the plot through the specification of
method and args.
The ‘execute’ property must be specified as a bool (either True, or False)
label¶Sets the text label to appear on the slider
A string
A number that will be converted to a string
method¶Sets the Plotly method to be called when the slider value is
changed. If the skip method is used, the API slider will
function as normal but will perform no API calls and will not
bind automatically to state updates. This may be used to create
a component interface and attach to slider events manually via
JavaScript.
[‘restyle’, ‘relayout’, ‘animate’, ‘update’, ‘skip’]
Any
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.
A string
A number that will be converted to a string
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.
A string
A number that will be converted to a string
value¶Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided.
A string
A number that will be converted to a string
plotly.graph_objects.layout.slider.Transition(arg=None, duration=None, easing=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
duration¶Sets the duration of the slider transition
An int or float in the interval [0, inf]
int|float
easing¶Sets the easing function of the slider transition
[‘linear’, ‘quad’, ‘cubic’, ‘sin’, ‘exp’, ‘circle’, ‘elastic’, ‘back’, ‘bounce’, ‘linear-in’, ‘quad-in’, ‘cubic-in’, ‘sin-in’, ‘exp-in’, ‘circle-in’, ‘elastic-in’, ‘back-in’, ‘bounce-in’, ‘linear-out’, ‘quad-out’, ‘cubic-out’, ‘sin-out’, ‘exp-out’, ‘circle-out’, ‘elastic-out’, ‘back-out’, ‘bounce-out’, ‘linear-in-out’, ‘quad-in-out’, ‘cubic-in-out’, ‘sin-in-out’, ‘exp-in-out’, ‘circle-in-out’, ‘elastic-in-out’, ‘back-in-out’, ‘bounce-in-out’]
Any