Lifemap

Lifemap(
    data,
    *,
    taxid_col='taxid',
    width=DEFAULT_WIDTH,
    height=DEFAULT_HEIGHT,
    zoom=None,
    controls=('zoom', 'reset_zoom', 'png_export', 'full_screen'),
    legend_width=None,
)

Build visualization.

Parameters

Name Type Description Default
data pl.DataFrame | pd.DataFrame Visualization data. required
taxid_col str Name of the data column with taxonomy ids, by default "taxid" 'taxid'
width int | str Lifemap visualization width, in pixels or CSS units, by default DEFAULT_WIDTH DEFAULT_WIDTH
height int | str Lifemap visualization height, in pixels or CSS units, by default DEFAULT_HEIGHT DEFAULT_HEIGHT
zoom int Default Lifemap zoom level, by default 4 or 5 depending on widget size None
controls Sequence[str] List of controls to be displayed on the widget. By default all controls are displayed. Available controls are: - “zoom”: zoom in and zoom out buttons - “reset_zoom”: zoom reset button - “png_export”: button to export current view to a PNG file - “full_screen”: full screen toggle button ('zoom', 'reset_zoom', 'png_export', 'full_screen')
legend_width int | None Legend width in pixels, by default None None

Examples

>>> import polars as pl
>>> from pylifemap import Lifemap
>>> d = pl.DataFrame({"taxid": [9685, 9615, 9994]})
>>> Lifemap(d, width="100%", height="100vh").layer_points().show()

Methods

Name Description
layer_points Add a points layer.
layer_lines Add a lines layer.
layer_donuts Add a donuts layer.
layer_heatmap Add an heatmap layer.
layer_heatmap_deck Add a deck.gl heatmap layer.
layer_screengrid Add a screengrid layer.
show Display the Jupyter widget for this instance.
save Save the Jupyter widget for this instance to an HTML file.