def __init__(
self,
arg=None,
count=None,
label=None,
step=None,
stepmode=None,
**kwargs
):
"""
Construct a new Button object
Sets the specifications for each buttons. By default, a range
selector comes with no buttons.
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
plotly.graph_objs.layout.xaxis.rangeselector.Button
count
Sets the number of steps to take to update the range.
Use with `step` to specify the update interval.
label
Sets the text label to appear on the button.
step
The unit of measurement that the `count` value will set
the range by.
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.
Returns
-------
Button
"""
super(Button, self).__init__('buttons')
# 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.xaxis.rangeselector.Button
constructor must be a dict or
an instance of plotly.graph_objs.layout.xaxis.rangeselector.Button"""
)
# Import validators
# -----------------
from plotly.validators.layout.xaxis.rangeselector import (
button as v_button
)
# Initialize validators
# ---------------------
self._validators['count'] = v_button.CountValidator()
self._validators['label'] = v_button.LabelValidator()
self._validators['step'] = v_button.StepValidator()
self._validators['stepmode'] = v_button.StepmodeValidator()
# Populate data dict with properties
# ----------------------------------
v = arg.pop('count', None)
self.count = count if count is not None else v
v = arg.pop('label', None)
self.label = label if label is not None else v
v = arg.pop('step', None)
self.step = step if step is not None else v
v = arg.pop('stepmode', None)
self.stepmode = stepmode if stepmode is not None else v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
def __init__(self,
arg=None,
count=None,
label=None,
name=None,
step=None,
stepmode=None,
templateitemname=None,
visible=None,
**kwargs):
"""
Construct a new Button object
Sets the specifications for each buttons. By default, a range
selector comes with no buttons.
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
plotly.graph_objs.layout.xaxis.rangeselector.Button
count
Sets the number of steps to take to update the range.
Use with `step` to specify the update interval.
label
Sets the text label to appear on the button.
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.
step
The unit of measurement that the `count` value will set
the range by.
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.
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`.
visible
Determines whether or not this button is visible.
Returns
-------
Button
"""
super(Button, self).__init__('buttons')
# 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.xaxis.rangeselector.Button
constructor must be a dict or
an instance of plotly.graph_objs.layout.xaxis.rangeselector.Button""")
# Handle skip_invalid
# -------------------
self._skip_invalid = kwargs.pop('skip_invalid', False)
# Import validators
# -----------------
from plotly.validators.layout.xaxis.rangeselector import (button as
v_button)
# Initialize validators
# ---------------------
self._validators['count'] = v_button.CountValidator()
self._validators['label'] = v_button.LabelValidator()
self._validators['name'] = v_button.NameValidator()
self._validators['step'] = v_button.StepValidator()
self._validators['stepmode'] = v_button.StepmodeValidator()
self._validators[
'templateitemname'] = v_button.TemplateitemnameValidator()
self._validators['visible'] = v_button.VisibleValidator()
# Populate data dict with properties
# ----------------------------------
_v = arg.pop('count', None)
self['count'] = count if count is not None else _v
_v = arg.pop('label', None)
self['label'] = label if label is not None else _v
_v = arg.pop('name', None)
self['name'] = name if name is not None else _v
_v = arg.pop('step', None)
self['step'] = step if step is not None else _v
_v = arg.pop('stepmode', None)
self['stepmode'] = stepmode if stepmode is not None else _v
_v = arg.pop('templateitemname', None)
self[
'templateitemname'] = templateitemname if templateitemname 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
