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

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 string in the following formats:

  • hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

  • hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

  • rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

  • rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

  • hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

  • hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

  • hwb (e.g. ‘hwb(0 0% 100%)’)

  • lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

  • color (e.g. ‘color(display-p3 1 0 0)’)

  • named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

  • Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

class plotly.graph_objects.layout.map.layer.Line(arg=None, dash=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 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

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.mapbox.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

str

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 If placement is “line”, the label is placed along the line of the geometry If placement 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

str

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:

Returns

Return type

plotly.graph_objects.layout.map.layer.symbol.Textfont

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