titiler module#

async jupyter_xarray_tiler.titiler.add_data_array(data_array, *, colormap_name='viridis', rescale=None, scale=1, algorithm=None, **kwargs)[source]#

Adds a DataArray to the TiTiler server and returns a URL template.

The TiTiler server is lazily started when the first DataArray is added.

Parameters:

  • data_array (DataArray) – An Xarray DataArray to dynamically tile for visualization.

  • colormap_name (str, default: 'viridis') – A rio-tiler colormap name.

  • rescale (tuple[float, float] | None, default: None) – Comma (‘,’) delimited Min,Max range.

  • scale (int, default: 1) – Tile size scale. Default 1 corresponds to 256*256px tiles.

  • algorithm (BaseAlgorithm | None, default: None) – Custom TiTiler algorithm name, e.g. “hillshade”.

  • kwargs (str | int) – Additional query parameters to include in the TiTiler request URL.

Returns:

str – A URL pointing to the new tile endpoint.

jupyter_xarray_tiler.titiler.get_routes()[source]#

Display a list of all available routes on the TiTiler server.

Returns:

list[dict[str, Any]] – A list containing one dictionary per route exposed by the TiTiler server.

Raises:

RuntimeError – If called before the server is started. Always await add_data_array() first.