> For the complete documentation index, see [llms.txt](https://nocode-artisan.gitbook.io/plotly-charts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nocode-artisan.gitbook.io/plotly-charts/additional-resources/elements-fields-reference/traces/geographical-charts/map-scatter.md). # Map Scatter (Line, Bubble) ### Geo JSON Options
Feature Id Key **Default Value**: id **Type**: string **Documentation**: Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*. **Path**: data.index.featureidkey
Geo Json **Type**: any **Documentation**: Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*. **Path**: data.index.geojson
*** ### Fill Options
Fill **Default Value**: none **Type**: enumerated **Enum Options**: none,toself **Documentation**: Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. **Path**: data.index.fill
Fill Color **Type**: color **Documentation**: Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. **Path**: data.index.fillcolor
*** ### Hover Formatting
Hover Info **Default Value**: all **Type**: flaglist **Accept List**: true **Flag Options**: lon,lat,location,text,name **Flag Single**: all,none,skip **Documentation**: Determines which trace information appear 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. **Path**: data.index.hoverinfo
Hover Template **Default Value**: **Type**: string **Accept List**: true **Documentation**: 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}". 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}". for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link . Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``. **Path**: data.index.hovertemplate
*** ### Data Source
Lat **Type**: any **Accept List**: true **Documentation**: Sets the latitude coordinates (in degrees North). **Path**: data.index.lat
Location Mode **Default Value**: ISO-3 **Type**: enumerated **Enum Options**: ISO-3,USA-states,country names,geojson-id **Documentation**: Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute. **Path**: data.index.locationmode
Locations **Type**: any **Accept List**: true **Documentation**: Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info. **Path**: data.index.locations
Lon **Type**: any **Accept List**: true **Documentation**: Sets the longitude coordinates (in degrees East). **Path**: data.index.lon
Text **Default Value**: **Type**: string **Accept List**: true **Documentation**: Sets text elements associated with each (lon,lat) pair or item in `locations`. 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) or `locations` coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels. **Path**: data.index.text
*** ### Lines Styling
Color **Type**: color **Documentation**: Sets the line color. **Path**: data.index.line.color
Dash **Default Value**: solid **Type**: string **Enum Options**: solid,dot,dash,longdash,dashdot,longdashdot **Documentation**: 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*). **Path**: data.index.line.dash
Width **Default Value**: 2 **Type**: number **Min**: 0 **Documentation**: Sets the line width (in px). **Path**: data.index.line.width
*** ### Items Styling
Angle **Default Value**: 0 **Type**: angle **Accept List**: true **Documentation**: Sets the marker angle in respect to `angleref`. **Path**: data.index.marker.angle
Angle Ref **Default Value**: up **Type**: enumerated **Enum Options**: previous,up,north **Documentation**: Sets the reference for marker angle. With *previous*, angle 0 points along the line from the previous point to this one. With *up*, angle 0 points toward the top of the screen. With *north*, angle 0 points north based on the current map projection. **Path**: data.index.marker.angleref
Color **Type**: color **Accept List**: true **Documentation**: 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. **Path**: data.index.marker.color
Gradient Color **Type**: color **Accept List**: true **Documentation**: Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical. **Path**: data.index.marker.gradient.color
Line Color **Type**: color **Accept List**: true **Documentation**: Sets the marker.line 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.line.cmin` and `marker.line.cmax` if set. **Path**: data.index.marker.line.color
Line Width **Type**: number **Accept List**: true **Min**: 0 **Documentation**: Sets the width (in px) of the lines bounding the marker points. **Path**: data.index.marker.line.width
Opacity **Type**: number **Accept List**: true **Min**: 0 **Max**: 1 **Documentation**: Sets the marker opacity. **Path**: data.index.marker.opacity
Size **Default Value**: 6 **Type**: number **Accept List**: true **Min**: 0 **Documentation**: Sets the marker size (in px). **Path**: data.index.marker.size
Size Mode **Default Value**: diameter **Type**: enumerated **Enum Options**: diameter,area **Documentation**: Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels. **Path**: data.index.marker.sizemode
Size Ref **Default Value**: 1 **Type**: number **Documentation**: Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`. **Path**: data.index.marker.sizeref
Symbol **Default Value**: circle **Type**: enumerated **Accept List**: true **Enum Options**: 0,0,circle,100,100,circle-open,200,200,circle-dot,300,300,circle-open-dot,1,1,square,101,101,square-open,201,201,square-dot,301,301,square-open-dot,2,2,diamond,102,102,diamond-open,202,202,diamond-dot,302,302,diamond-open-dot,3,3,cross,103,103,cross-open,203,203,cross-dot,303,303,cross-open-dot,4,4,x,104,104,x-open,204,204,x-dot,304,304,x-open-dot,5,5,triangle-up,105,105,triangle-up-open,205,205,triangle-up-dot,305,305,triangle-up-open-dot,6,6,triangle-down,106,106,triangle-down-open,206,206,triangle-down-dot,306,306,triangle-down-open-dot,7,7,triangle-left,107,107,triangle-left-open,207,207,triangle-left-dot,307,307,triangle-left-open-dot,8,8,triangle-right,108,108,triangle-right-open,208,208,triangle-right-dot,308,308,triangle-right-open-dot,9,9,triangle-ne,109,109,triangle-ne-open,209,209,triangle-ne-dot,309,309,triangle-ne-open-dot,10,10,triangle-se,110,110,triangle-se-open,210,210,triangle-se-dot,310,310,triangle-se-open-dot,11,11,triangle-sw,111,111,triangle-sw-open,211,211,triangle-sw-dot,311,311,triangle-sw-open-dot,12,12,triangle-nw,112,112,triangle-nw-open,212,212,triangle-nw-dot,312,312,triangle-nw-open-dot,13,13,pentagon,113,113,pentagon-open,213,213,pentagon-dot,313,313,pentagon-open-dot,14,14,hexagon,114,114,hexagon-open,214,214,hexagon-dot,314,314,hexagon-open-dot,15,15,hexagon2,115,115,hexagon2-open,215,215,hexagon2-dot,315,315,hexagon2-open-dot,16,16,octagon,116,116,octagon-open,216,216,octagon-dot,316,316,octagon-open-dot,17,17,star,117,117,star-open,217,217,star-dot,317,317,star-open-dot,18,18,hexagram,118,118,hexagram-open,218,218,hexagram-dot,318,318,hexagram-open-dot,19,19,star-triangle-up,119,119,star-triangle-up-open,219,219,star-triangle-up-dot,319,319,star-triangle-up-open-dot,20,20,star-triangle-down,120,120,star-triangle-down-open,220,220,star-triangle-down-dot,320,320,star-triangle-down-open-dot,21,21,star-square,121,121,star-square-open,221,221,star-square-dot,321,321,star-square-open-dot,22,22,star-diamond,122,122,star-diamond-open,222,222,star-diamond-dot,322,322,star-diamond-open-dot,23,23,diamond-tall,123,123,diamond-tall-open,223,223,diamond-tall-dot,323,323,diamond-tall-open-dot,24,24,diamond-wide,124,124,diamond-wide-open,224,224,diamond-wide-dot,324,324,diamond-wide-open-dot,25,25,hourglass,125,125,hourglass-open,26,26,bowtie,126,126,bowtie-open,27,27,circle-cross,127,127,circle-cross-open,28,28,circle-x,128,128,circle-x-open,29,29,square-cross,129,129,square-cross-open,30,30,square-x,130,130,square-x-open,31,31,diamond-cross,131,131,diamond-cross-open,32,32,diamond-x,132,132,diamond-x-open,33,33,cross-thin,133,133,cross-thin-open,34,34,x-thin,134,134,x-thin-open,35,35,asterisk,135,135,asterisk-open,36,36,hash,136,136,hash-open,236,236,hash-dot,336,336,hash-open-dot,37,37,y-up,137,137,y-up-open,38,38,y-down,138,138,y-down-open,39,39,y-left,139,139,y-left-open,40,40,y-right,140,140,y-right-open,41,41,line-ew,141,141,line-ew-open,42,42,line-ns,142,142,line-ns-open,43,43,line-ne,143,143,line-ne-open,44,44,line-nw,144,144,line-nw-open,45,45,arrow-up,145,145,arrow-up-open,46,46,arrow-down,146,146,arrow-down-open,47,47,arrow-left,147,147,arrow-left-open,48,48,arrow-right,148,148,arrow-right-open,49,49,arrow-bar-up,149,149,arrow-bar-up-open,50,50,arrow-bar-down,150,150,arrow-bar-down-open,51,51,arrow-bar-left,151,151,arrow-bar-left-open,52,52,arrow-bar-right,152,152,arrow-bar-right-open,53,53,arrow,153,153,arrow-open,54,54,arrow-wide,154,154,arrow-wide-open **Documentation**: Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name. **Path**: data.index.marker.symbol
*** ### Color Scale Options
Auto Color Scale **Default Value**: true **Type**: boolean **Documentation**: 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. **Path**: data.index.marker.autocolorscale
C Auto **Default Value**: true **Type**: boolean **Documentation**: 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. **Path**: data.index.marker.cauto
C Max **Type**: number **Documentation**: 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. **Path**: data.index.marker.cmax
C Mid **Type**: number **Documentation**: 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`. **Path**: data.index.marker.cmid
C Min **Type**: number **Documentation**: 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. **Path**: data.index.marker.cmin
Color Scale **Type**: colorscale **Documentation**: Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. **Path**: data.index.marker.colorscale
Reverse Scale **Default Value**: false **Type**: boolean **Documentation**: Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. **Path**: data.index.marker.reversescale
Show Scale **Default Value**: false **Type**: boolean **Documentation**: Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array. **Path**: data.index.marker.showscale
*** ### Color Bar Layout
Colorbar Bg Color **Default Value**: rgba(0,0,0,0) **Type**: color **Documentation**: Sets the color of padded area. **Path**: data.index.marker.colorbar.bgcolor
Colorbar Border Color **Default Value**: #444 **Type**: color **Documentation**: Sets the axis line color. **Path**: data.index.marker.colorbar.bordercolor
Colorbar Border Width **Default Value**: 0 **Type**: number **Min**: 0 **Documentation**: Sets the width (in px) or the border enclosing this color bar. **Path**: data.index.marker.colorbar.borderwidth
Colorbar Len **Default Value**: 1 **Type**: number **Min**: 0 **Documentation**: 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. **Path**: data.index.marker.colorbar.len
Colorbar Len Mode **Default Value**: fraction **Type**: enumerated **Enum Options**: fraction,pixels **Documentation**: 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. **Path**: data.index.marker.colorbar.lenmode
Colorbar Outline Color **Default Value**: #444 **Type**: color **Documentation**: Sets the axis line color. **Path**: data.index.marker.colorbar.outlinecolor
Colorbar Outline Width **Default Value**: 1 **Type**: number **Min**: 0 **Documentation**: Sets the width (in px) of the axis line. **Path**: data.index.marker.colorbar.outlinewidth
Colorbar Thickness **Default Value**: 30 **Type**: number **Min**: 0 **Documentation**: Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels. **Path**: data.index.marker.colorbar.thickness
Colorbar Thickness Mode **Default Value**: pixels **Type**: enumerated **Enum Options**: fraction,pixels **Documentation**: 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. **Path**: data.index.marker.colorbar.thicknessmode
*** ### Color Bar Ticks Options
Colorbar D Tick **Type**: any **Documentation**: 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*, 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* 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* **Path**: data.index.marker.colorbar.dtick
Colorbar N Ticks **Default Value**: 0 **Type**: integer **Min**: 0 **Documentation**: 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*. **Path**: data.index.marker.colorbar.nticks
Colorbar Show Tick Labels **Default Value**: true **Type**: boolean **Documentation**: Determines whether or not the tick labels are drawn. **Path**: data.index.marker.colorbar.showticklabels
Colorbar Ticks **Default Value**: **Type**: enumerated **Enum Options**: outside,inside, **Documentation**: Determines whether ticks are drawn or not. If \*\*, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines. **Path**: data.index.marker.colorbar.ticks
*** ### Color Bar Positioning
Colorbar Orientation **Default Value**: v **Type**: enumerated **Enum Options**: h,v **Documentation**: Sets the orientation of the colorbar. **Path**: data.index.marker.colorbar.orientation
Colorbar X **Type**: number **Documentation**: Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*. **Path**: data.index.marker.colorbar.x
Colorbar X Anchor **Type**: enumerated **Enum Options**: left,center,right **Documentation**: Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*. **Path**: data.index.marker.colorbar.xanchor
Colorbar Y **Type**: number **Documentation**: Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*. **Path**: data.index.marker.colorbar.y
Colorbar Y Anchor **Type**: enumerated **Enum Options**: top,middle,bottom **Documentation**: Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*. **Path**: data.index.marker.colorbar.yanchor
*** ### Color Bar Title Options
Font Color **Type**: color **Path**: data.index.marker.colorbar.title.font.color
Font Size **Type**: number **Min**: 1 **Path**: data.index.marker.colorbar.title.font.size
Title Side **Type**: enumerated **Enum Options**: right,top,bottom **Documentation**: Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute. **Path**: data.index.marker.colorbar.title.side
Title Text **Type**: string **Documentation**: Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated. **Path**: data.index.marker.colorbar.title.text
*** ### Basic Options
Mode **Default Value**: markers **Type**: flaglist **Flag Options**: lines,markers,text **Flag Single**: none **Documentation**: 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. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*. **Path**: data.index.mode
Name **Type**: string **Documentation**: Sets the trace name. The trace name appears as the legend item and on hover. **Path**: data.index.name
Opacity **Default Value**: 1 **Type**: number **Min**: 0 **Max**: 1 **Documentation**: Sets the opacity of the trace. **Path**: data.index.opacity
*** ### Text Formatting
Color **Type**: color **Accept List**: true **Path**: data.index.textfont.color
Size **Type**: number **Accept List**: true **Min**: 1 **Path**: data.index.textfont.size
Text Position **Default Value**: middle center **Type**: enumerated **Accept List**: true **Enum Options**: top left,top center,top right,middle left,middle center,middle right,bottom left,bottom center,bottom right **Documentation**: Sets the positions of the `text` elements with respects to the (x,y) coordinates. **Path**: data.index.textposition
Text Template **Default Value**: **Type**: string **Accept List**: true **Documentation**: Template string used for rendering the information text that appear 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}". 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}". for details on the date formatting syntax. Every 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`, `location` and `text`. **Path**: data.index.texttemplate
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://nocode-artisan.gitbook.io/plotly-charts/additional-resources/elements-fields-reference/traces/geographical-charts/map-scatter.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.