plotly.graph_objects.layout.geo package

class plotly.graph_objects.layout.geo.Center(arg=None, lat=None, lon=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property lat

Sets the latitude of the map’s center. For all projection types, the map’s latitude center lies at the middle of the latitude range by default.

The ‘lat’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

property lon

Sets the longitude of the map’s center. By default, the map’s longitude center lies at the middle of the longitude range for scoped projection and above projection.rotation.lon otherwise.

The ‘lon’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

class plotly.graph_objects.layout.geo.Domain(arg=None, column=None, row=None, x=None, y=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property column

If there is a layout grid, use the domain for this column in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

The ‘column’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property row

If there is a layout grid, use the domain for this row in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

The ‘row’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property x
Sets the horizontal domain of this geo subplot (in plot

fraction). Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

The ‘x’ property is an info array that may be specified as:

  • a list or tuple of 2 elements where:

  1. The ‘x[0]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

  2. The ‘x[1]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

    list

property y
Sets the vertical domain of this geo subplot (in plot

fraction). Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

The ‘y’ property is an info array that may be specified as:

  • a list or tuple of 2 elements where:

  1. The ‘y[0]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

  2. The ‘y[1]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

    list

class plotly.graph_objects.layout.geo.Lataxis(arg=None, dtick=None, gridcolor=None, griddash=None, gridwidth=None, range=None, showgrid=None, tick0=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property dtick

Sets the graticule’s longitude/latitude tick step.

The ‘dtick’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

property gridcolor

Sets the graticule’s stroke color.

The ‘gridcolor’ 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

property griddash

Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).

The ‘griddash’ property is an enumeration that may be specified as:
  • One of the following dash styles:

    [‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]

  • A string containing a dash length list in pixels or percentages

    (e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns

Return type

str

property gridwidth

Sets the graticule’s stroke width (in px).

The ‘gridwidth’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property range
Sets the range of this axis (in degrees), sets the map’s

clipped coordinates.

The ‘range’ property is an info array that may be specified as:

  • a list or tuple of 2 elements where:

  1. The ‘range[0]’ property is a number and may be specified as:

    • An int or float

  2. The ‘range[1]’ property is a number and may be specified as:

    • An int or float

    list

property showgrid

Sets whether or not graticule are shown on the map.

The ‘showgrid’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property tick0

Sets the graticule’s starting tick longitude/latitude.

The ‘tick0’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

class plotly.graph_objects.layout.geo.Lonaxis(arg=None, dtick=None, gridcolor=None, griddash=None, gridwidth=None, range=None, showgrid=None, tick0=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property dtick

Sets the graticule’s longitude/latitude tick step.

The ‘dtick’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

property gridcolor

Sets the graticule’s stroke color.

The ‘gridcolor’ 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

property griddash

Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).

The ‘griddash’ property is an enumeration that may be specified as:
  • One of the following dash styles:

    [‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]

  • A string containing a dash length list in pixels or percentages

    (e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns

Return type

str

property gridwidth

Sets the graticule’s stroke width (in px).

The ‘gridwidth’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property range
Sets the range of this axis (in degrees), sets the map’s

clipped coordinates.

The ‘range’ property is an info array that may be specified as:

  • a list or tuple of 2 elements where:

  1. The ‘range[0]’ property is a number and may be specified as:

    • An int or float

  2. The ‘range[1]’ property is a number and may be specified as:

    • An int or float

    list

property showgrid

Sets whether or not graticule are shown on the map.

The ‘showgrid’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property tick0

Sets the graticule’s starting tick longitude/latitude.

The ‘tick0’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

class plotly.graph_objects.layout.geo.Projection(arg=None, distance=None, parallels=None, rotation=None, scale=None, tilt=None, type=None, **kwargs)

Bases: plotly.basedatatypes.BaseLayoutHierarchyType

property distance

For satellite projection type only. Sets the distance from the center of the sphere to the point of view as a proportion of the sphere’s radius.

The ‘distance’ property is a number and may be specified as:

  • An int or float in the interval [1.001, inf]

Returns

Return type

int|float

property parallels
For conic projection types only. Sets the parallels (tangent,

secant) where the cone intersects the sphere.

The ‘parallels’ property is an info array that may be specified as:

  • a list or tuple of 2 elements where:

  1. The ‘parallels[0]’ property is a number and may be specified as:

    • An int or float

  2. The ‘parallels[1]’ property is a number and may be specified as:

    • An int or float

    list

property rotation

The ‘rotation’ property is an instance of Rotation that may be specified as:

  • An instance of plotly.graph_objects.layout.geo.projection.Rotation

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

    Supported dict properties:

    lat

    Rotates the map along meridians (in degrees North).

    lon

    Rotates the map along parallels (in degrees East). Defaults to the center of the lonaxis.range values.

    roll

    Roll the map (in degrees) For example, a roll of 180 makes the map appear upside down.

Returns

Return type

plotly.graph_objects.layout.geo.projection.Rotation

property scale

Zooms in or out on the map view. A scale of 1 corresponds to the largest zoom level that fits the map’s lon and lat ranges.

The ‘scale’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property tilt

For satellite projection type only. Sets the tilt angle of perspective projection.

The ‘tilt’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

property type

Sets the projection type.

The ‘type’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘airy’, ‘aitoff’, ‘albers’, ‘albers usa’, ‘august’, ‘azimuthal equal area’, ‘azimuthal equidistant’, ‘baker’, ‘bertin1953’, ‘boggs’, ‘bonne’, ‘bottomley’, ‘bromley’, ‘collignon’, ‘conic conformal’, ‘conic equal area’, ‘conic equidistant’, ‘craig’, ‘craster’, ‘cylindrical equal area’, ‘cylindrical stereographic’, ‘eckert1’, ‘eckert2’, ‘eckert3’, ‘eckert4’, ‘eckert5’, ‘eckert6’, ‘eisenlohr’, ‘equal earth’, ‘equirectangular’, ‘fahey’, ‘foucaut’, ‘foucaut sinusoidal’, ‘ginzburg4’, ‘ginzburg5’, ‘ginzburg6’, ‘ginzburg8’, ‘ginzburg9’, ‘gnomonic’, ‘gringorten’, ‘gringorten quincuncial’, ‘guyou’, ‘hammer’, ‘hill’, ‘homolosine’, ‘hufnagel’, ‘hyperelliptical’, ‘kavrayskiy7’, ‘lagrange’, ‘larrivee’, ‘laskowski’, ‘loximuthal’, ‘mercator’, ‘miller’, ‘mollweide’, ‘mt flat polar parabolic’, ‘mt flat polar quartic’, ‘mt flat polar sinusoidal’, ‘natural earth’, ‘natural earth1’, ‘natural earth2’, ‘nell hammer’, ‘nicolosi’, ‘orthographic’, ‘patterson’, ‘peirce quincuncial’, ‘polyconic’, ‘rectangular polyconic’, ‘robinson’, ‘satellite’, ‘sinu mollweide’, ‘sinusoidal’, ‘stereographic’, ‘times’, ‘transverse mercator’, ‘van der grinten’, ‘van der grinten2’, ‘van der grinten3’, ‘van der grinten4’, ‘wagner4’, ‘wagner6’, ‘wiechel’, ‘winkel tripel’, ‘winkel3’]

Returns

Return type

Any