Python > Figure Reference > choroplethmapbox Traces

Python Figure Reference: choroplethmapbox Traces

A plotly.graph_objects.Choroplethmapbox trace is a graph object in the figure's data list with any of the named arguments or attributes listed below.

"choroplethmapbox" trace is deprecated! Please consider switching to the "choroplethmap" trace type and `map` subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ GeoJSON features to be filled are set in `geojson` The data that describes the choropleth value-to-color mapping is set in `locations` and `z`.

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='choroplethmapbox'))
    Type: string

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

  • visible
    Code: fig.update_traces(visible=<VALUE>, selector=dict(type='choroplethmapbox'))
    Type: enumerated , one of ( True | False | "legendonly" )
    Default: True

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

  • showlegend
    Code: fig.update_traces(showlegend=<VALUE>, selector=dict(type='choroplethmapbox'))
    Type: boolean

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

  • legend
    Code: fig.update_traces(legend=<VALUE>, selector=dict(type='choroplethmapbox'))
    Type: subplotid
    Default: 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.

  • legendrank
    Code: fig.update_traces(legendrank=<VALUE>, selector=dict(type='choroplethmapbox'))
    Type: number
    Default: 1000

    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.

  • legendgroup
    Code: fig.update_traces(legendgroup=<VALUE>, selector=dict(type='choroplethmapbox'))
    Type: string