Sets the trace name. The trace name appears as the legend item and on hover.

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Determines whether or not an item corresponding to this trace is shown in the legend.

Sets the reference to a legend to show this trace in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

• font
  Parent: data[type=scattermap].legendgrouptitle
  Type: object containing one or more of the keys listed below.

  Sets this legend group's title font.

  • color
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: color
  • family
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: string

    HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

  • lineposition
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
    Examples: "under", "over", "under+over", "under+over+through", "none"
    Default: "none"

    Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

  • shadow
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: string
    Default: "none"

    Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

  • size
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: number greater than or equal to 1
  • style
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: enumerated , one of ( "normal" | "italic" )
    Default: "normal"

    Sets whether a font should be styled with a normal or italic face from its family.

  • textcase
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
    Default: "normal"

    Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

  • variant
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
    Default: "normal"

    Sets the variant of the font.

  • weight
    Parent: data[type=scattermap].legendgrouptitle.font
    Type: integer between or equal to 1 and 1000
    Default: normal

    Sets the weight (or boldness) of the font.

• text
  Parent: data[type=scattermap].legendgrouptitle
  Type: string
  Default: ""

  Sets the title of the legend group.

Sets the width (in px or fraction) of the legend for this trace.

Sets the opacity of the trace.

Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

Sets the latitude coordinates (in degrees North).

Sets the longitude coordinates (in degrees East).

• color
  Parent: data[type=scattermap].cluster
  Type: color or array of colors

  Sets the color for each cluster step.

• enabled
  Parent: data[type=scattermap].cluster
  Type: boolean

  Determines whether clustering is enabled or disabled.

• maxzoom
  Parent: data[type=scattermap].cluster
  Type: number between or equal to 0 and 24
  Default: 24

  Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.

• opacity
  Parent: data[type=scattermap].cluster
  Type: number or array of numbers between or equal to 0 and 1
  Default: 1

  Sets the marker opacity.

• size
  Parent: data[type=scattermap].cluster
  Type: number or array of numbers greater than or equal to 0
  Default: 20

  Sets the size for each cluster step.

• step
  Parent: data[type=scattermap].cluster
  Type: number or array of numbers greater than or equal to -1
  Default: -1

  Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.

Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

Sets the positions of the `text` elements with respects to the (x,y) coordinates.

Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `lat`, `lon` and `text`.

Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.

Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.

Determines what trace information appears on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.

Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

Sets a reference between this trace's data coordinates and a map subplot. If "map" (the default value), the data refer to `layout.map`. If "map2", the data refer to `layout.map2`, and so on.

• allowoverlap
  Parent: data[type=scattermap].marker
  Type: boolean

  Flag to draw all symbols, even if they overlap.

• angle
  Parent: data[type=scattermap].marker
  Type: number or array of numbers
  Default: "auto"

  Sets the marker orientation from true North, in degrees clockwise. When using the "auto" default, no rotation would be applied in perspective views which is different from using a zero angle.

• autocolorscale
  Parent: data[type=scattermap].marker
  Type: boolean
  Default: true

  Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

• cauto
  Parent: data[type=scattermap].marker
  Type: boolean
  Default: true

  Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.

• cmax
  Parent: data[type=scattermap].marker
  Type: number

  Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.

• cmid
  Parent: data[type=scattermap].marker
  Type: number

  Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.

• cmin
  Parent: data[type=scattermap].marker
  Type: number

  Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.

• color
  Parent: data[type=scattermap].marker
  Type: color or array of colors

  Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

• coloraxis
  Parent: data[type=scattermap].marker
  Type: subplotid

  Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

• colorbar
  Parent: data[type=scattermap].marker
  Type: object containing one or more of the keys listed below.
  • bgcolor
    Parent: data[type=scattermap].marker.colorbar
    Type: color
    Default: "rgba(0,0,0,0)"

    Sets the color of padded area.

  • bordercolor
    Parent: data[type=scattermap].marker.colorbar
    Type: color
    Default: "#444"

    Sets the axis line color.

  • borderwidth
    Parent: data[type=scattermap].marker.colorbar
    Type: number greater than or equal to 0
    Default: 0

    Sets the width (in px) or the border enclosing this color bar.

  • dtick
    Parent: data[type=scattermap].marker.colorbar
    Type: number or categorical coordinate string

    Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

  • exponentformat
    Parent: data[type=scattermap].marker.colorbar
    Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" | "SI extended" )
    Default: "B"

    Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.

  • labelalias
    Parent: data[type=scattermap].marker.colorbar
    Type: number or categorical coordinate string

    Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.

  • len
    Parent: data[type=scattermap].marker.colorbar
    Type: number greater than or equal to 0
    Default: 1

    Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

  • lenmode
    Parent: data[type=scattermap].marker.colorbar
    Type: enumerated , one of ( "fraction" | "pixels" )
    Default: "fraction"

    Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

  • minexponent
    Parent: data[type=scattermap].marker.colorbar
    Type: number greater than or equal to 0
    Default: 3

    Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".

  • nticks
    Parent: data[type=scattermap].marker.colorbar
    Type: integer greater than or equal to 0
    Default: 0

    Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

  • orientation
    Parent: data[type=scattermap].marker.colorbar
    Type: enumerated , one of ( "h" | "v" )
    Default: "v"

    Sets the orientation of the colorbar.

  • outlinecolor
    Parent: data[type=scattermap].marker.colorbar
    Type: color
    Default: "#444"

    Sets the axis line color.

  • outlinewidth
    Parent: data[type=scattermap].marker.colorbar
    Type: number greater than or equal to 0
    Default: 1

    Sets the width (in px) of the axis line.

  • separatethousands
    Parent: data[type=scattermap].marker.colorbar
    Type: boolean

    If "true", even 4-digit integers are separated

  • showexponent
    Parent: data[type=scattermap].marker.colorbar
    Type: enumerated , one of ( "all" | "first" | "last" | "none" )
    Default: "all"

    If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

  • showticklabels
    Parent: data[type=scattermap].marker.colorbar
    Type: boolean
    Default: true

    Determines whether or not the tick labels are drawn.

  • showtickprefix
    Parent: data[type=scattermap].marker.colorbar
    Type: enumerated , one of ( "all" | "first" | "last" | "none" )
    Default: "all"

    If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

  • showticksuffix
    Parent: data[type=scattermap].marker.colorbar
    Type: enumerated , one of ( "all" | "first" | "last" | "none" )
    Default: "all"

    Same as `showtickprefix` but for tick suffixes.

  • thickness
    Parent: data[type=scattermap].marker.colorbar
    Type: number greater than or equal to 0
    Default: 30

    Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

  • thicknessmode
    Parent: data[type=scattermap].marker.colorbar
    Type: enumerated , one of ( "fraction" | "pixels" )
    Default: "pixels"

    Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.

  • tick0