Python Figure Reference: densitymap Traces

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

Draws a bivariate kernel density estimation with a Gaussian kernel from `lon` and `lat` coordinates and optional `z` values using a colorscale.

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='densitymap'))
    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='densitymap'))
    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='densitymap'))
    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='densitymap'))
    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='densitymap'))
    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='densitymap'))
    Type: string
    Default: ""

    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.

  • legendgrouptitle
    Code: fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='densitymap'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='densitymap'))
      Type: dict containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Code: fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='densitymap'))
        Type: color
      • family
        Code: fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='densitymap'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='densitymap'))
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Code: fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='densitymap'))
      Type: string
      Default: ""

      Sets the title of the legend group.

  • legendwidth
    Code: fig.update_traces(legendwidth=<VALUE>, selector=dict(type='densitymap'))
    Type: number greater than or equal to 0

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

  • opacity
    Code: fig.update_traces(opacity=<VALUE>, selector=dict(type='densitymap'))
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='densitymap'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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.

  • z
    Code: fig.update_traces(z=<VALUE>, selector=dict(type='densitymap'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

  • radius
    Code: fig.update_traces(radius=<VALUE>, selector=dict(type='densitymap'))
    Type: number or array of numbers greater than or equal to 1
    Default: 30

    Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymap trace smoother, but less detailed.

  • lat
    Code: fig.update_traces(lat=<VALUE>, selector=dict(type='densitymap'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the latitude coordinates (in degrees North).

  • lon
    Code: fig.update_traces(lon=<VALUE>, selector=dict(type='densitymap'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the longitude coordinates (in degrees East).

  • text
    Code: fig.update_traces(text=<VALUE>, selector=dict(type='densitymap'))
    Type: string or array of strings
    Default: ""

    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.

  • hovertext
    Code: fig.update_traces(hovertext=<VALUE>, selector=dict(type='densitymap'))
    Type: string or array of strings
    Default: ""

    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.

  • hoverinfo
    Code: fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='densitymap'))
    Type: flaglist string. Any combination of "lon", "lat", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    Examples: "lon", "lat", "lon+lat", "lon+lat+z", "all"
    Default: "all"

    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.

  • hovertemplate
    Code: fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='densitymap'))
    Type: string or array of strings
    Default: ""

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

  • hovertemplatefallback
    Code: fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='densitymap'))
    Type: number or categorical coordinate string
    Default: -

    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.

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='densitymap'))
    Type: number or categorical coordinate string

    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.

  • customdata
    Code: fig.update_traces(customdata=<VALUE>, selector=dict(type='densitymap'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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

  • subplot
    Code: fig.update_traces(subplot=<VALUE>, selector=dict(type='densitymap'))
    Type: subplotid
    Default: map

    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.

  • coloraxis
    Code: fig.update_traces(coloraxis=<VALUE>, selector=dict(type='densitymap'))
    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
    Code: fig.update_traces(colorbar=dict(...), selector=dict(type='densitymap'))
    Type: dict containing one or more of the keys listed below.
    • bgcolor
      Code: fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='densitymap'))
      Type: color
      Default: "rgba(0,0,0,0)"

      Sets the color of padded area.

    • bordercolor
      Code: fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='densitymap'))
      Type: color
      Default: "#444"

      Sets the axis line color.

    • borderwidth
      Code: fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='densitymap'))
      Type: number greater than or equal to 0
      Default: 0

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

    • dtick
      Code: fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='densitymap'))
      Type: enumerated , one of ( "h" | "v" )
      Default: "v"

      Sets the orientation of the colorbar.

    • outlinecolor
      Code: fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='densitymap'))
      Type: color
      Default: "#444"

      Sets the axis line color.

    • outlinewidth
      Code: fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='densitymap'))
      Type: number greater than or equal to 0
      Default: 1

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

    • separatethousands
      Code: fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='densitymap'))
      Type: boolean

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

    • showexponent
      Code: fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='densitymap'))
      Type: boolean
      Default: True

      Determines whether or not the tick labels are drawn.

    • showtickprefix
      Code: fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='densitymap'))
      Type: enumerated , one of ( "all" | "first" | "last" | "none" )
      Default: "all"

      Same as `showtickprefix` but for tick suffixes.

    • thickness
      Code: fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='densitymap'))
      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
      Code: fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='densitymap'))
      Type: number or categorical coordinate string

      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    • tickangle
      Code: fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='densitymap'))
      Type: angle
      Default: "auto"

      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

    • tickcolor
      Code: fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='densitymap'))
      Type: color
      Default: "#444"

      Sets the tick color.

    • tickfont
      Code: fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='densitymap'))
      Type: dict containing one or more of the keys listed below.

      Sets the color bar's tick label font

      • color
        Code: fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='densitymap'))
        Type: color
      • family
        Code: fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='densitymap'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='densitymap'))
        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
        Code: fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='densitymap'))
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • tickformat
      Code: fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='densitymap'))
      Type: string
      Default: ""