Python Figure Reference: pointcloud Traces

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

"pointcloud" trace is deprecated! Please consider switching to the "scattergl" trace type. The data visualized as a point cloud set in `x` and `y` using the WebGl plotting engine.

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

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

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

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

  • legendrank
    Code: fig.update_traces(legendrank=<VALUE>, selector=dict(type='pointcloud'))
    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.

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

    Sets the legend group for this trace. Traces 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='pointcloud'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='pointcloud'))
      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='pointcloud'))
        Type: color
      • family
        Code: fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='pointcloud'))
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

      • size
        Code: fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='pointcloud'))
        Type: number greater than or equal to 1
    • text
      Code: fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='pointcloud'))
      Type: string
      Default: ""

      Sets the title of the legend group.

  • opacity
    Code: fig.update_traces(opacity=<VALUE>, selector=dict(type='pointcloud'))
    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='pointcloud'))
    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.

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

    Sets the x coordinates.

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

    Sets the y coordinates.

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

    Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i " 2] = x[i]` and `xy[i " 2 + 1] = y[i]`

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

    Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits.

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

    Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits.

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

    A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call.

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

    Sets text elements associated with each (x,y) 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 (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

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

    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.

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='pointcloud'))
    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='pointcloud'))
    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

  • xaxis
    Code: fig.update_traces(xaxis=<VALUE>, selector=dict(type='pointcloud'))
    Type: subplotid
    Default: x

    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.

  • yaxis
    Code: fig.update_traces(yaxis=<VALUE>, selector=dict(type='pointcloud'))
    Type: subplotid
    Default: y

    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.

  • marker
    Code: fig.update_traces(marker=dict(...), selector=dict(type='pointcloud'))
    Type: dict containing one or more of the keys listed below.
    • blend
      Code: fig.update_traces(marker_blend=<VALUE>, selector=dict(type='pointcloud'))
      Type: boolean

      Determines if colors are blended together for a translucency effect in case `opacity` is specified as a value less then `1`. Setting `blend` to `True` reduces zoom/pan speed if used with large numbers of points.

    • border
      Code: fig.update_traces(marker_border=dict(...), selector=dict(type='pointcloud'))
      Type: dict containing one or more of the keys listed below.
      • arearatio
        Code: fig.update_traces(marker_border_arearatio=<VALUE>, selector=dict(type='pointcloud'))
        Type: number between or equal to 0 and 1
        Default: 0

        Specifies what fraction of the marker area is covered with the border.

      • color
        Code: fig.update_traces(marker_border_color=<VALUE>, selector=dict(type='pointcloud'))
        Type: color

        Sets the stroke color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.

    • color
      Code: fig.update_traces(marker_color=<VALUE>, selector=dict(type='pointcloud'))
      Type: color

      Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are hundreds of thousandsof points, it may cause slower zooming and panning.

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

      Sets the marker opacity. The default value is `1` (fully opaque). If the markers are not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning. Opacity fades the color even if `blend` is left on `False` even if there is no translucency effect in that case.

    • sizemax
      Code: fig.update_traces(marker_sizemax=<VALUE>, selector=dict(type='pointcloud'))
      Type: number greater than or equal to 0.1
      Default: 20

      Sets the maximum size (in px) of the rendered marker points. Effective when the `pointcloud` shows only few points.

    • sizemin
      Code: fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='pointcloud'))
      Type: number between or equal to 0.1 and 2
      Default: 0.5

      Sets the minimum size (in px) of the rendered marker points, effective when the `pointcloud` shows a million or more points.

  • hoverlabel
    Code: fig.update_traces(hoverlabel=dict(...), selector=dict(type='pointcloud'))
    Type: dict containing one or more of the keys listed below.
    • align
      Code: fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='pointcloud'))
      Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
      Default: "auto"

      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

    • bgcolor
      Code: fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='pointcloud'))
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Code: fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='pointcloud'))
      Type: color or array of colors

      Sets the border color of the hover labels for this trace.

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

      Sets the font used in hover labels.

      • color
        Code: fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='pointcloud'))
        Type: color or array of colors
      • family
        Code: fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='pointcloud'))
        Type: string or array of strings

        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

      • size
        Code: fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='pointcloud'))
        Type: number or array of numbers greater than or equal to 1
    • namelength
      Code: fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='pointcloud'))
      Type: integer or array of integers greater than or equal to -1
      Default: 15

      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

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

    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: True` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: True}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.