SliderStep (Plotly.NET)

Plotly.NET

Documentation for 4.2.0

SliderStep Type

Namespace: Plotly.NET.LayoutObjects
Assembly: Plotly.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

The object including the slider steps style and update parameters

Constructors

Constructor	Description
`SliderStep()` Full Usage: `SliderStep()` Returns: `SliderStep`	Returns: `SliderStep`

Static members

Static member Description

Static member	Description
`SliderStep.init (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)` Full Usage: `SliderStep.init (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)` Parameters: ?Args : `seq<string * obj>` - Sets the arguments values to be passed to the Plotly method set in `method` on slide ?Execute : `bool` - 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 : `string` - Sets the text label to appear on the slider ?Method : `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 ?Name : `string` - 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 ?TemplateItemName : `string` - 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` ?Value : `string` - Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided ?Visible : `bool` - Determines whether or not this step is included in the slider Returns: `SliderStep`	Initializes the slider with style parameters ?Args : `seq<string * obj>` Sets the arguments values to be passed to the Plotly method set in `method` on slide ?Execute : `bool` 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 : `string` Sets the text label to appear on the slider ?Method : `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 ?Name : `string` 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 ?TemplateItemName : `string` 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` ?Value : `string` Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided ?Visible : `bool` Determines whether or not this step is included in the slider Returns: `SliderStep`
`SliderStep.style (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)` Full Usage: `SliderStep.style (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)` Parameters: ?Args : `seq<string * obj>` ?Execute : `bool` ?Label : `string` ?Method : `Method` ?Name : `string` ?TemplateItemName : `string` ?Value : `string` ?Visible : `bool` Returns: `SliderStep -> SliderStep`	?Args : `seq<string * obj>` ?Execute : `bool` ?Label : `string` ?Method : `Method` ?Name : `string` ?TemplateItemName : `string` ?Value : `string` ?Visible : `bool` Returns: `SliderStep -> SliderStep`


                
                  
                    
                      SliderStep.init (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)

Full Usage: SliderStep.init (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)

Parameters:

?Args : seq<string * obj> - Sets the arguments values to be passed to the Plotly method set in `method` on slide

?Execute : bool - 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 : string - Sets the text label to appear on the slider

?Method : 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

?Name : string - 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

?TemplateItemName : string - 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`

?Value : string - Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided

?Visible : bool - Determines whether or not this step is included in the slider

Returns: SliderStep

Initializes the slider with style parameters

?Args : seq<string * obj>: Sets the arguments values to be passed to the Plotly method set in `method` on slide
?Execute : bool: 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 : string: Sets the text label to appear on the slider
?Method : 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
?Name : string: 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
?TemplateItemName : string: 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`
?Value : string: Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided
?Visible : bool: Determines whether or not this step is included in the slider

Returns: SliderStep


                
                  
                    
                      SliderStep.style (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)

Full Usage: SliderStep.style (?Args, ?Execute, ?Label, ?Method, ?Name, ?TemplateItemName, ?Value, ?Visible)

Parameters:

?Args : seq<string * obj>

?Execute : bool

?Label : string

?Method : Method

?Name : string

?TemplateItemName : string

?Value : string

?Visible : bool

Returns: SliderStep -> SliderStep

?Args : seq<string * obj>
?Execute : bool
?Label : string
?Method : Method
?Name : string
?TemplateItemName : string
?Value : string
?Visible : bool

Returns: SliderStep -> SliderStep