done
This commit is contained in:
@ -0,0 +1,495 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Fillpattern(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "scatter"
|
||||
_path_str = "scatter.fillpattern"
|
||||
_valid_props = {
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"fgcolor",
|
||||
"fgcolorsrc",
|
||||
"fgopacity",
|
||||
"fillmode",
|
||||
"path",
|
||||
"pathsrc",
|
||||
"shape",
|
||||
"shapesrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"solidity",
|
||||
"soliditysrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def bgcolor(self):
|
||||
"""
|
||||
When there is no colorscale sets the color of background
|
||||
pattern fill. Defaults to a `marker.color` background when
|
||||
`fillmode` is "overlay". Otherwise, defaults to a transparent
|
||||
background.
|
||||
|
||||
The 'bgcolor' property is a color and may be specified as:
|
||||
- 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%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bgcolor"]
|
||||
|
||||
@bgcolor.setter
|
||||
def bgcolor(self, val):
|
||||
self["bgcolor"] = val
|
||||
|
||||
@property
|
||||
def bgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `bgcolor`.
|
||||
|
||||
The 'bgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bgcolorsrc"]
|
||||
|
||||
@bgcolorsrc.setter
|
||||
def bgcolorsrc(self, val):
|
||||
self["bgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def fgcolor(self):
|
||||
"""
|
||||
When there is no colorscale sets the color of foreground
|
||||
pattern fill. Defaults to a `marker.color` background when
|
||||
`fillmode` is "replace". Otherwise, defaults to dark grey or
|
||||
white to increase contrast with the `bgcolor`.
|
||||
|
||||
The 'fgcolor' property is a color and may be specified as:
|
||||
- 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%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["fgcolor"]
|
||||
|
||||
@fgcolor.setter
|
||||
def fgcolor(self, val):
|
||||
self["fgcolor"] = val
|
||||
|
||||
@property
|
||||
def fgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `fgcolor`.
|
||||
|
||||
The 'fgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["fgcolorsrc"]
|
||||
|
||||
@fgcolorsrc.setter
|
||||
def fgcolorsrc(self, val):
|
||||
self["fgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def fgopacity(self):
|
||||
"""
|
||||
Sets the opacity of the foreground pattern fill. Defaults to a
|
||||
0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
|
||||
|
||||
The 'fgopacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["fgopacity"]
|
||||
|
||||
@fgopacity.setter
|
||||
def fgopacity(self, val):
|
||||
self["fgopacity"] = val
|
||||
|
||||
@property
|
||||
def fillmode(self):
|
||||
"""
|
||||
Determines whether `marker.color` should be used as a default
|
||||
to `bgcolor` or a `fgcolor`.
|
||||
|
||||
The 'fillmode' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['replace', 'overlay']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["fillmode"]
|
||||
|
||||
@fillmode.setter
|
||||
def fillmode(self, val):
|
||||
self["fillmode"] = val
|
||||
|
||||
@property
|
||||
def path(self):
|
||||
"""
|
||||
Sets a custom path for pattern fill. Use with no `shape` or
|
||||
`solidity`, provide an SVG path string for the regions of the
|
||||
square from (0,0) to (`size`,`size`) to color.
|
||||
|
||||
The 'path' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["path"]
|
||||
|
||||
@path.setter
|
||||
def path(self, val):
|
||||
self["path"] = val
|
||||
|
||||
@property
|
||||
def pathsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `path`.
|
||||
|
||||
The 'pathsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["pathsrc"]
|
||||
|
||||
@pathsrc.setter
|
||||
def pathsrc(self, val):
|
||||
self["pathsrc"] = val
|
||||
|
||||
@property
|
||||
def shape(self):
|
||||
"""
|
||||
Sets the shape of the pattern fill. By default, no pattern is
|
||||
used for filling the area.
|
||||
|
||||
The 'shape' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['', '/', '\\', 'x', '-', '|', '+', '.']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["shape"]
|
||||
|
||||
@shape.setter
|
||||
def shape(self, val):
|
||||
self["shape"] = val
|
||||
|
||||
@property
|
||||
def shapesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shape`.
|
||||
|
||||
The 'shapesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shapesrc"]
|
||||
|
||||
@shapesrc.setter
|
||||
def shapesrc(self, val):
|
||||
self["shapesrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
Sets the size of unit squares of the pattern fill in pixels,
|
||||
which corresponds to the interval of repetition of the pattern.
|
||||
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def solidity(self):
|
||||
"""
|
||||
Sets the solidity of the pattern fill. Solidity is roughly the
|
||||
fraction of the area filled by the pattern. Solidity of 0 shows
|
||||
only the background color without pattern and solidty of 1
|
||||
shows only the foreground color without pattern.
|
||||
|
||||
The 'solidity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["solidity"]
|
||||
|
||||
@solidity.setter
|
||||
def solidity(self, val):
|
||||
self["solidity"] = val
|
||||
|
||||
@property
|
||||
def soliditysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `solidity`.
|
||||
|
||||
The 'soliditysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["soliditysrc"]
|
||||
|
||||
@soliditysrc.setter
|
||||
def soliditysrc(self, val):
|
||||
self["soliditysrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
bgcolor
|
||||
When there is no colorscale sets the color of
|
||||
background pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "overlay". Otherwise,
|
||||
defaults to a transparent background.
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
fgcolor
|
||||
When there is no colorscale sets the color of
|
||||
foreground pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "replace". Otherwise,
|
||||
defaults to dark grey or white to increase contrast
|
||||
with the `bgcolor`.
|
||||
fgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`fgcolor`.
|
||||
fgopacity
|
||||
Sets the opacity of the foreground pattern fill.
|
||||
Defaults to a 0.5 when `fillmode` is "overlay".
|
||||
Otherwise, defaults to 1.
|
||||
fillmode
|
||||
Determines whether `marker.color` should be used as a
|
||||
default to `bgcolor` or a `fgcolor`.
|
||||
path
|
||||
Sets a custom path for pattern fill. Use with no
|
||||
`shape` or `solidity`, provide an SVG path string for
|
||||
the regions of the square from (0,0) to (`size`,`size`)
|
||||
to color.
|
||||
pathsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`path`.
|
||||
shape
|
||||
Sets the shape of the pattern fill. By default, no
|
||||
pattern is used for filling the area.
|
||||
shapesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shape`.
|
||||
size
|
||||
Sets the size of unit squares of the pattern fill in
|
||||
pixels, which corresponds to the interval of repetition
|
||||
of the pattern.
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
solidity
|
||||
Sets the solidity of the pattern fill. Solidity is
|
||||
roughly the fraction of the area filled by the pattern.
|
||||
Solidity of 0 shows only the background color without
|
||||
pattern and solidty of 1 shows only the foreground
|
||||
color without pattern.
|
||||
soliditysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`solidity`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
fgcolor=None,
|
||||
fgcolorsrc=None,
|
||||
fgopacity=None,
|
||||
fillmode=None,
|
||||
path=None,
|
||||
pathsrc=None,
|
||||
shape=None,
|
||||
shapesrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
solidity=None,
|
||||
soliditysrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Fillpattern object
|
||||
|
||||
Sets the pattern within the marker.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.scatter.Fillpattern`
|
||||
bgcolor
|
||||
When there is no colorscale sets the color of
|
||||
background pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "overlay". Otherwise,
|
||||
defaults to a transparent background.
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
fgcolor
|
||||
When there is no colorscale sets the color of
|
||||
foreground pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "replace". Otherwise,
|
||||
defaults to dark grey or white to increase contrast
|
||||
with the `bgcolor`.
|
||||
fgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`fgcolor`.
|
||||
fgopacity
|
||||
Sets the opacity of the foreground pattern fill.
|
||||
Defaults to a 0.5 when `fillmode` is "overlay".
|
||||
Otherwise, defaults to 1.
|
||||
fillmode
|
||||
Determines whether `marker.color` should be used as a
|
||||
default to `bgcolor` or a `fgcolor`.
|
||||
path
|
||||
Sets a custom path for pattern fill. Use with no
|
||||
`shape` or `solidity`, provide an SVG path string for
|
||||
the regions of the square from (0,0) to (`size`,`size`)
|
||||
to color.
|
||||
pathsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`path`.
|
||||
shape
|
||||
Sets the shape of the pattern fill. By default, no
|
||||
pattern is used for filling the area.
|
||||
shapesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shape`.
|
||||
size
|
||||
Sets the size of unit squares of the pattern fill in
|
||||
pixels, which corresponds to the interval of repetition
|
||||
of the pattern.
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
solidity
|
||||
Sets the solidity of the pattern fill. Solidity is
|
||||
roughly the fraction of the area filled by the pattern.
|
||||
Solidity of 0 shows only the background color without
|
||||
pattern and solidty of 1 shows only the foreground
|
||||
color without pattern.
|
||||
soliditysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`solidity`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Fillpattern
|
||||
"""
|
||||
super().__init__("fillpattern")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
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.scatter.Fillpattern
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.scatter.Fillpattern`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("bgcolor", arg, bgcolor)
|
||||
self._set_property("bgcolorsrc", arg, bgcolorsrc)
|
||||
self._set_property("fgcolor", arg, fgcolor)
|
||||
self._set_property("fgcolorsrc", arg, fgcolorsrc)
|
||||
self._set_property("fgopacity", arg, fgopacity)
|
||||
self._set_property("fillmode", arg, fillmode)
|
||||
self._set_property("path", arg, path)
|
||||
self._set_property("pathsrc", arg, pathsrc)
|
||||
self._set_property("shape", arg, shape)
|
||||
self._set_property("shapesrc", arg, shapesrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("solidity", arg, solidity)
|
||||
self._set_property("soliditysrc", arg, soliditysrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
Reference in New Issue
Block a user