Skip to content

BrushingExtension

lonboard.experimental.BrushingExtension

Adds GPU-based data brushing functionalities to layers. It allows the layer to show/hide objects based on the current pointer position.

brushing_enabled class-attribute instance-attribute 

brushing_enabled = traitlets.Bool(True).tag(sync=True)

Enable/disable brushing. If brushing is disabled, all objects are rendered.

  • Type: bool, optional
  • Default: True

brushing_radius class-attribute instance-attribute 

brushing_radius = traitlets.Float(allow_none=True, min=0).tag(sync=True)

The brushing radius centered at the pointer, in meters. If a data object is within this circle, it is rendered; otherwise it is hidden.

  • Type: float, optional
  • Default: 10000

brushing_target class-attribute instance-attribute 

brushing_target = traitlets.Unicode('source', allow_none=True).tag(sync=True)

The position used to filter each object by.

  • Type: str, optional

    One of: 'source' | 'target' | 'source_target' | 'custom'

  • Default: 10000

get_brushing_target class-attribute instance-attribute 

get_brushing_target = traitlets.Any(allow_none=True).tag(sync=True)

Called to retrieve an arbitrary position for each object that it will be filtered by.

Only effective if brushingTarget is set to "custom".