def __init__(self,
arg=None,
args=None,
execute=None,
label=None,
method=None,
name=None,
templateitemname=None,
value=None,
visible=None,
**kwargs):
"""
Construct a new Step object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of plotly.graph_objs.layout.slider.Step
args
Sets the arguments values to be passed to the Plotly
method set in `method` on slide.
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`.
label
Sets the text label to appear on the slider
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
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
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
Sets the value of the slider step, used to refer to the
step programatically. Defaults to the slider label if
not provided.
visible
Determines whether or not this step is included in the
slider.
Returns
-------
Step
"""
super(Step, self).__init__('steps')
# Validate arg
# ------------
if arg is None:
arg = {}
elif isinstance(arg, self.__class__):
arg = arg.to_plotly_json()
elif isinstance(arg, dict):
arg = copy.copy(arg)
else:
raise ValueError("""\
The first argument to the plotly.graph_objs.layout.slider.Step
constructor must be a dict or
an instance of plotly.graph_objs.layout.slider.Step""")
# Handle skip_invalid
# -------------------
self._skip_invalid = kwargs.pop('skip_invalid', False)
# Import validators
# -----------------
from plotly.validators.layout.slider import (step as v_step)
# Initialize validators
# ---------------------
self._validators['args'] = v_step.ArgsValidator()
self._validators['execute'] = v_step.ExecuteValidator()
self._validators['label'] = v_step.LabelValidator()
self._validators['method'] = v_step.MethodValidator()
self._validators['name'] = v_step.NameValidator()
self._validators[
'templateitemname'] = v_step.TemplateitemnameValidator()
self._validators['value'] = v_step.ValueValidator()
self._validators['visible'] = v_step.VisibleValidator()
# Populate data dict with properties
# ----------------------------------
_v = arg.pop('args', None)
self['args'] = args if args is not None else _v
_v = arg.pop('execute', None)
self['execute'] = execute if execute is not None else _v
_v = arg.pop('label', None)
self['label'] = label if label is not None else _v
_v = arg.pop('method', None)
self['method'] = method if method is not None else _v
_v = arg.pop('name', None)
self['name'] = name if name is not None else _v
_v = arg.pop('templateitemname', None)
self[
'templateitemname'] = templateitemname if templateitemname is not None else _v
_v = arg.pop('value', None)
self['value'] = value if value is not None else _v
_v = arg.pop('visible', None)
self['visible'] = visible if visible is not None else _v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
# Reset skip_invalid
# ------------------
self._skip_invalid = False
def __init__(self,
arg=None,
args=None,
execute=None,
label=None,
method=None,
value=None,
**kwargs):
"""
Construct a new Step object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of plotly.graph_objs.layout.slider.Step
args
Sets the arguments values to be passed to the Plotly
method set in `method` on slide.
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`.
label
Sets the text label to appear on the slider
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.
value
Sets the value of the slider step, used to refer to the
step programatically. Defaults to the slider label if
not provided.
Returns
-------
Step
"""
super(Step, self).__init__('steps')
# Validate arg
# ------------
if arg is None:
arg = {}
elif isinstance(arg, self.__class__):
arg = arg.to_plotly_json()
elif isinstance(arg, dict):
arg = copy.copy(arg)
else:
raise ValueError("""\
The first argument to the plotly.graph_objs.layout.slider.Step
constructor must be a dict or
an instance of plotly.graph_objs.layout.slider.Step""")
# Import validators
# -----------------
from plotly.validators.layout.slider import (step as v_step)
# Initialize validators
# ---------------------
self._validators['args'] = v_step.ArgsValidator()
self._validators['execute'] = v_step.ExecuteValidator()
self._validators['label'] = v_step.LabelValidator()
self._validators['method'] = v_step.MethodValidator()
self._validators['value'] = v_step.ValueValidator()
# Populate data dict with properties
# ----------------------------------
v = arg.pop('args', None)
self.args = args if args is not None else v
v = arg.pop('execute', None)
self.execute = execute if execute is not None else v
v = arg.pop('label', None)
self.label = label if label is not None else v
v = arg.pop('method', None)
self.method = method if method is not None else v
v = arg.pop('value', None)
self.value = value if value is not None else v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
