plotly.graph_objects.layout.map.layer package¶
-
class
plotly.graph_objects.layout.map.layer.
Circle
(arg=None, radius=None, **kwargs)¶ Bases:
plotly.basedatatypes.BaseLayoutHierarchyType
-
property
radius
¶ Sets the circle radius (map.layer.paint.circle-radius). Has an effect only when
type
is set to “circle”.- The ‘radius’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
-
class
plotly.graph_objects.layout.map.layer.
Fill
(arg=None, outlinecolor=None, **kwargs)¶ Bases:
plotly.basedatatypes.BaseLayoutHierarchyType
-
property
outlinecolor
¶ Sets the fill outline color (map.layer.paint.fill-outline- color). Has an effect only when
type
is set to “fill”.- The ‘outlinecolor’ 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
- Returns
- Return type
-
property
-
class
plotly.graph_objects.layout.map.layer.
Line
(arg=None, dash=None, dashsrc=None, width=None, **kwargs)¶ Bases:
plotly.basedatatypes.BaseLayoutHierarchyType
-
property
dash
¶ Sets the length of dashes and gaps (map.layer.paint.line- dasharray). Has an effect only when
type
is set to “line”.The ‘dash’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
- Returns
- Return type
numpy.ndarray
-
property
dashsrc
¶ Sets the source reference on Chart Studio Cloud for
dash
.The ‘dashsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
width
¶ Sets the line width (map.layer.paint.line-width). Has an effect only when
type
is set to “line”.- The ‘width’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
-
class
plotly.graph_objects.layout.map.layer.
Symbol
(arg=None, icon=None, iconsize=None, placement=None, text=None, textfont=None, textposition=None, **kwargs)¶ Bases:
plotly.basedatatypes.BaseLayoutHierarchyType
-
property
icon
¶ Sets the symbol icon image (map.layer.layout.icon-image). Full list: https://www.map.com/maki-icons/
- The ‘icon’ property is a string and must be specified as:
A string
A number that will be converted to a string
- Returns
- Return type
-
property
iconsize
¶ Sets the symbol icon size (map.layer.layout.icon-size). Has an effect only when
type
is set to “symbol”.- The ‘iconsize’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
placement
¶ Sets the symbol and/or text placement (map.layer.layout.symbol- placement). If
placement
is “point”, the label is placed where the geometry is located Ifplacement
is “line”, the label is placed along the line of the geometry Ifplacement
is “line-center”, the label is placed on the center of the geometry- The ‘placement’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘point’, ‘line’, ‘line-center’]
- Returns
- Return type
Any
-
property
text
¶ Sets the symbol text (map.layer.layout.text-field).
- The ‘text’ property is a string and must be specified as:
A string
A number that will be converted to a string
- Returns
- Return type
-
property
textfont
¶ Sets the icon text font (color=map.layer.paint.text-color, size=map.layer.layout.text-size). Has an effect only when
type
is set to “symbol”.The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.layout.map.layer.symbol.Textfont
A dict of string/value properties that will be passed to the Textfont constructor
- Returns
- Return type
-
property
textposition
¶ Sets the positions of the
text
elements with respects to the (x,y) coordinates.- The ‘textposition’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top left’, ‘top center’, ‘top right’, ‘middle left’, ‘middle center’, ‘middle right’, ‘bottom left’, ‘bottom center’, ‘bottom right’]
- Returns
- Return type
Any
-
property