plotly.graph_objects.layout.mapbox.layer package

class plotly.graph_objects.layout.mapbox.layer.Circle(arg=None, radius=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property radius

Sets the circle radius (mapbox.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.mapbox.layer.Fill(arg=None, outlinecolor=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property outlinecolor

Sets the fill outline color (mapbox.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:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns

Return type

str

class plotly.graph_objects.layout.mapbox.layer.Line(arg=None, dash=None, dashsrc=None, width=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property dash

Sets the length of dashes and gaps (mapbox.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

str

property width

Sets the line width (mapbox.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.mapbox.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 (mapbox.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 (mapbox.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 (mapbox.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 (mapbox.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=mapbox.layer.paint.text-color, size=mapbox.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.mapbox.layer.symbol.Textfont

  • A dict of string/value properties that will be passed to the Textfont constructor

    Supported dict properties:

    color

    family

    HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

    size

Returns

Return type

plotly.graph_objects.layout.mapbox.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