Skip to content

ArcLayer

Screen recording from U.S. County-to-County Migration example.

lonboard.ArcLayer

Bases: BaseArrowLayer

Render raised arcs joining pairs of source and target coordinates.

auto_highlight 

auto_highlight = Bool(default_value=False)

When true, the current object pointed to by the mouse pointer (when hovered over) is highlighted with highlightColor.

Requires pickable to be True.

  • Type: bool
  • Default: False

before_id 

before_id = Unicode(None, allow_none=True)

The identifier of a layer in the Maplibre basemap layer stack.

This deck.gl layer will be rendered just before the layer with the given identifier. You can find such an identifier by inspecting the basemap style JSON.

For example, in the Carto Positron style, if you look at the raw JSON data, each layer has an "id" property. The first layer in the basemap stack has "id": "background". So if you pass before_id="background", you won't see your deck.gl layer because it will be rendered below all layers in the Maplibre basemap.

A common choice for Carto-based styles is to use before_id="watername_ocean" so that your deck.gl layer is rendered above the core basemap elements but below all text labels.

Info

This only has an effect when the map's basemap is a MaplibreBasemap, and the map is rendering in "interleaved" mode.

extensions 

extensions = tag(sync=True, **(widget_serialization))

A list of layer extension objects to add additional features to a layer.

get_height 

get_height = FloatAccessor(None, allow_none=True)

Height color of each object

get_source_color 

get_source_color = ColorAccessor(None, allow_none=True)

Source color of each object

get_source_position 

get_source_position = PointAccessor(None, allow_none=True)

Source position of each object

get_target_color 

get_target_color = ColorAccessor(None, allow_none=True)

Target color of each object

get_target_position 

get_target_position = PointAccessor(None, allow_none=True)

Target position of each object

get_tilt 

get_tilt = FloatAccessor(None, allow_none=True)

Use to tilt the arc to the side if you have multiple arcs with the same source and target positions.

  • Type: FloatAccessor, optional
    • If a number is provided, it is used as the width for all paths.
    • If an array is provided, each value in the array will be used as the width for the path at the same row index.
  • Default: 0.

get_width 

get_width = FloatAccessor(None, allow_none=True)

The line width of each object, in units specified by widthUnits.

  • Type: FloatAccessor, optional
    • If a number is provided, it is used as the width for all paths.
    • If an array is provided, each value in the array will be used as the width for the path at the same row index.
  • Default: 1.

great_circle 

great_circle = Bool(None, allow_none=True)

If True, create the arc along the shortest path on the earth surface.

  • Type: bool, optional
  • Default: False

highlight_color 

highlight_color = VariableLengthTuple(
    Int(), default_value=(0, 0, 128, 128), minlen=3, maxlen=4
)

RGBA color to blend with the highlighted object (the hovered over object if auto_highlight=true). When the value is a 3 component (RGB) array, a default alpha of 255 is applied.

  • Type: List or Tuple of integers
  • Default: [0, 0, 128, 128]

num_segments 

num_segments = Int(None, allow_none=True)

The number of segments used to draw each arc.

  • Type: int, optional
  • Default: 50

opacity 

opacity = Float(1, min=0, max=1)

The opacity of the layer.

  • Type: float. Must range between 0 and 1.
  • Default: 1

pickable 

pickable = Bool(default_value=True)

Whether the layer responds to mouse pointer picking events.

This must be set to True for tooltips and other interactive elements to be available. This can also be used to only allow picking on specific layers within a map instance.

Note that picking has some performance overhead in rendering. To get the absolute best rendering performance with large data (at the cost of removing interactivity), set this to False.

  • Type: bool
  • Default: True

selected_index 

selected_index = Int(None, allow_none=True)

The positional index of the most-recently clicked on row of data.

You can use this to access the full row of data from a GeoDataFrame

gdf.iloc[layer.selected_index]

Setting a value here from Python will do nothing. This attribute only exists to be updated from JavaScript on a map click. Note that pickable must be True (the default) on this layer for the JavaScript onClick handler to work; if pickable is set to False, selected_index will never update.

Note that you can use observe to call a function whenever a new value is received from JavaScript. Refer here for an example.

table 

table = ArrowTableTrait(geometry_required=False)

A GeoArrow table.

This is the fastest way to plot data from an existing GeoArrow source, such as geoarrow-rust or geoarrow-pyarrow.

visible 

visible = Bool(default_value=True)

Whether the layer is visible.

Under most circumstances, using the visible attribute to control the visibility of layers is recommended over removing/adding the layer from the Map.layers list.

In particular, toggling the visible attribute will persist the layer on the JavaScript side, while removing/adding the layer from the Map.layers list will re-download and re-render from scratch.

  • Type: bool
  • Default: True

width_max_pixels 

width_max_pixels = Float(None, allow_none=True, min=0)

The maximum line width in pixels.

  • Type: float, optional
  • Default: None

width_min_pixels 

width_min_pixels = Float(None, allow_none=True, min=0)

The minimum line width in pixels.

  • Type: float, optional
  • Default: 0

width_scale 

width_scale = Float(None, allow_none=True, min=0)

The scaling multiplier for the width of each line.

  • Type: float, optional
  • Default: 1

width_units 

width_units = Unicode(None, allow_none=True)

The units of the line width, one of 'meters', 'common', and 'pixels'. See unit system.

  • Type: str, optional
  • Default: 'pixels'

__init__ 

__init__(
    table: ArrowStreamExportable,
    *,
    get_source_position: PointAccessorInput,
    get_target_position: PointAccessorInput,
    _rows_per_chunk: int | None = None,
    **kwargs: Unpack[ArcLayerKwargs]
) -> None

Construct an ArcLayer from existing Arrow data.

Parameters:

  • table (ArrowStreamExportable) –

    An Arrow table from any Arrow-compatible library. This does not need to have a geometry column as geometries are passed separately in get_source_position and get_target_position.

Other Parameters:

  • get_source_position (PointAccessorInput) –

    Source position of each object.

  • get_target_position (PointAccessorInput) –

    Target position of each object.

  • kwargs (Unpack[ArcLayerKwargs]) –

    Extra args passed down as ArcLayer attributes.

from_duckdb 

from_duckdb(
    sql: str | DuckDBPyRelation,
    con: DuckDBPyConnection | None = None,
    *,
    crs: str | CRS | None = None,
    **kwargs: Unpack[BaseLayerKwargs]
) -> Self

Construct a Layer from a duckdb-spatial query.

With DuckDB >= 1.5, the CRS of a GEOMETRY column is read automatically from the column type (e.g. GEOMETRY('EPSG:3857')) and the data is reprojected to EPSG:4326 as needed.

The crs keyword parameter is deprecated for such input and is only needed when the data cannot describe its own CRS: WKB_BLOB or 2D columns (POINT_2D, LINESTRING_2D, POLYGON_2D, BOX_2D), DuckDB older than 1.5, or a GEOMETRY column without a CRS encoded. In those cases, the user must ensure that data has been reprojected to EPSG:4326 or pass the existing CRS of the data in the crs keyword parameter.

Parameters:

  • sql (str | DuckDBPyRelation) –

    The SQL input to visualize. This can either be a string containing a SQL query or the output of the duckdb sql function.

  • con (DuckDBPyConnection | None, default: None ) –

    The current DuckDB connection. This is required when passing a str to the sql parameter.

Other Parameters:

  • crs (str | CRS | None) –

    The CRS of the input data, for input that cannot describe its own CRS (see above). This can either be a string passed to pyproj.CRS.from_user_input or a pyproj.CRS object. Errors if it conflicts with the CRS encoded in a DuckDB >= 1.5 GEOMETRY column. Defaults to None.

  • kwargs (Unpack[BaseLayerKwargs]) –

    parameters passed on to __init__

Returns:

  • Self –

    A Layer with the initialized data.

from_geopandas 

from_geopandas(
    gdf: GeoDataFrame,
    *,
    auto_downcast: bool = True,
    **kwargs: Unpack[BaseLayerKwargs]
) -> Self

Construct a Layer from a geopandas GeoDataFrame.

The GeoDataFrame will be reprojected to EPSG:4326 if it is not already in that coordinate system.

Parameters:

  • gdf (GeoDataFrame) –

    The GeoDataFrame to set on the layer.

Other Parameters:

  • auto_downcast (bool) –

    If True, automatically downcast to smaller-size data types if possible without loss of precision. This calls pandas.DataFrame.convert_dtypes and pandas.to_numeric under the hood.

  • kwargs (Unpack[BaseLayerKwargs]) –

    parameters passed on to __init__

Returns:

  • Self –

    A Layer with the initialized data.