R Figure Reference: layout.sliders
- sliders
Parent:layout
Type: list of named list where each named list has one or more of the keys listed below.- active
Parent:layout.sliders[]
Type: number greater than or equal to 0
Default:0
Determines which button (by index starting from 0) is considered active.
- activebgcolor
Parent:layout.sliders[]
Type: color
Default:"#dbdde0"
Sets the background color of the slider grip while dragging.
- bgcolor
Parent:layout.sliders[]
Type: color
Default:"#f8fafc"
Sets the background color of the slider.
- bordercolor
Parent:layout.sliders[]
Type: color
Default:"#bec8d9"
Sets the color of the border enclosing the slider.
- borderwidth
Parent:layout.sliders[]
Type: number greater than or equal to 0
Default:1
Sets the width (in px) of the border enclosing the slider.
- currentvalue
Parent:layout.sliders[]
Type: named list containing one or more of the keys listed below.- font
Parent:layout.sliders[].currentvalue
Type: named list containing one or more of the keys listed below.Sets the font of the current value label text.
- color
Parent:layout.sliders[].currentvalue.font
Type: color - family
Parent:layout.sliders[].currentvalue.font
Type: stringHTML 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
Parent:layout.sliders[].currentvalue.font
Type: flaglist string. Any combination of"under"
,"over"
,"through"
joined with a"+"
OR"none"
.
Examples:"under"
,"over"
,"under+over"
,"under+over+through"
,"none"
Default:"none"
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
Parent:layout.sliders[].currentvalue.font
Type: string
Default:"none"
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
Parent:layout.sliders[].currentvalue.font
Type: number greater than or equal to 1 - style
Parent:layout.sliders[].currentvalue.font
Type: enumerated , one of ("normal"
|"italic"
)
Default:"normal"
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:layout.sliders[].currentvalue.font
Type: enumerated , one of ("normal"
|"word caps"
|"upper"
|"lower"
)
Default:"normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:layout.sliders[].currentvalue.font
Type: enumerated , one of ("normal"
|"small-caps"
|"all-small-caps"
|"all-petite-caps"
|"petite-caps"
|"unicase"
)
Default:"normal"
Sets the variant of the font.
- weight
Parent:layout.sliders[].currentvalue.font
Type: integer between or equal to 1 and 1000
Default:normal
Sets the weight (or boldness) of the font.
- color
- offset
Parent:layout.sliders[].currentvalue
Type: number
Default:10
The amount of space, in pixels, between the current value label and the slider.
- prefix
Parent:layout.sliders[].currentvalue
Type: stringWhen currentvalue.visible is TRUE, this sets the prefix of the label.
- suffix
Parent:layout.sliders[].currentvalue
Type: stringWhen currentvalue.visible is TRUE, this sets the suffix of the label.
- visible
Parent:layout.sliders[].currentvalue
Type: boolean
Default:TRUE
Shows the currently-selected value above the slider.
- xanchor
Parent:layout.sliders[].currentvalue
Type: enumerated , one of ("left"
|"center"
|"right"
)
Default:"left"
The alignment of the value readout relative to the length of the slider.
- font
- font
Parent:layout.sliders[]
Type: named list containing one or more of the keys listed below.Sets the font of the slider step labels.
- color
Parent:layout.sliders[].font
Type: color - family
Parent:layout.sliders[].font
Type: stringHTML 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
Parent:layout.sliders[].font
Type: flaglist string. Any combination of"under"
,"over"
,"through"
joined with a"+"
OR"none"
.
Examples:"under"
,"over"
,"under+over"
,"under+over+through"
,"none"
Default:"none"
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
Parent:layout.sliders[].font
Type: string
Default:"none"
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
Parent:layout.sliders[].font
Type: number greater than or equal to 1 - style
Parent:layout.sliders[].font
Type: enumerated , one of ("normal"
|"italic"
)
Default:"normal"
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:layout.sliders[].font
Type: enumerated , one of ("normal"
|"word caps"
|"upper"
|"lower"
)
Default:"normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:layout.sliders[].font
Type: enumerated , one of ("normal"
|"small-caps"
|"all-small-caps"
|"all-petite-caps"
|"petite-caps"
|"unicase"
)
Default:"normal"
Sets the variant of the font.
- weight
Parent:layout.sliders[].font
Type: integer between or equal to 1 and 1000
Default:normal
Sets the weight (or boldness) of the font.
- color
- len
Parent:layout.sliders[]
Type: number greater than or equal to 0
Default:1
Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends.
- lenmode
Parent:layout.sliders[]
Type: enumerated , one of ("fraction"
|"pixels"
)
Default:"fraction"
Determines whether this slider length is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minorticklen
Parent:layout.sliders[]
Type: number greater than or equal to 0
Default:4
Sets the length in pixels of minor step tick marks
- name
Parent:layout.sliders[]
Type: stringWhen 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.
- pad
Parent:layout.sliders[]
Type: named list containing one or more of the keys listed below.Set the padding of the slider component along each side.
- b
Parent:layout.sliders[].pad
Type: number
Default:0
The amount of padding (in px) along the bottom of the component.
- l
Parent:layout.sliders[].pad
Type: number
Default:0
The amount of padding (in px) on the left side of the component.
- r
Parent:layout.sliders[].pad
Type: number
Default:0
The amount of padding (in px) on the right side of the component.
- t
Parent:layout.sliders[].pad
Type: number
Default:20
The amount of padding (in px) along the top of the component.
- b
- steps
Parent:layout.sliders[]
Type: list of named list where each named list has one or more of the keys listed below.- args
Parent:layout.sliders[].steps[]
Type: listSets the arguments values to be passed to the Plotly method set in `method` on slide.
- execute
Parent:layout.sliders[].steps[]
Type: boolean
Default:TRUE
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`.
- label
Parent:layout.sliders[].steps[]
Type: stringSets the text label to appear on the slider
- method
Parent:layout.sliders[].steps[]
Type: enumerated , one of ("restyle"
|"relayout"
|"animate"
|"update"
|"skip"
)
Default:"restyle"
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.
- name
Parent:layout.sliders[].steps[]
Type: stringWhen 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.sliders[].steps[]
Type: stringUsed 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`.
- value
Parent:layout.sliders[].steps[]
Type: stringSets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided.
- visible
Parent:layout.sliders[].steps[]
Type: boolean
Default:TRUE
Determines whether or not this step is included in the slider.
- args
- templateitemname
Parent:layout.sliders[]
Type: stringUsed 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`.
- tickcolor
Parent:layout.sliders[]
Type: color
Default:"#333"
Sets the color of the border enclosing the slider.
- ticklen
Parent:layout.sliders[]
Type: number greater than or equal to 0
Default:7
Sets the length in pixels of step tick marks
- tickwidth
Parent:layout.sliders[]
Type: number greater than or equal to 0
Default:1
Sets the tick width (in px).
- transition
Parent:layout.sliders[]
Type: named list containing one or more of the keys listed below.- duration
Parent:layout.sliders[].transition
Type: number greater than or equal to 0
Default:150
Sets the duration of the slider transition
- easing
Parent:layout.sliders[].transition
Type: enumerated , one of ("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"
)
Default:"cubic-in-out"
Sets the easing function of the slider transition
- duration
- visible
Parent:layout.sliders[]
Type: boolean
Default:TRUE
Determines whether or not the slider is visible.
- x
Parent:layout.sliders[]
Type: number between or equal to -2 and 3
Default:0
Sets the x position (in normalized coordinates) of the slider.
- xanchor
Parent:layout.sliders[]
Type: enumerated , one of ("auto"
|"left"
|"center"
|"right"
)
Default:"left"
Sets the slider's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.
- y
Parent:layout.sliders[]
Type: number between or equal to -2 and 3
Default:0
Sets the y position (in normalized coordinates) of the slider.
- yanchor
Parent:layout.sliders[]
Type: enumerated , one of ("auto"
|"top"
|"middle"
|"bottom"
)
Default:"top"
Sets the slider's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.
- active