here.inspector package#

HERE Platform Python SDK, Jupyter GeoData Inspector package

here.inspector.inspect(features: GeoSeries | GeoDataFrame | BaseGeometry | Iterable[BaseGeometry] | Iterable[Tuple[BaseGeometry, Dict[str, Any]]] | Dict[str, Any] | Iterable[Dict[str, Any]] | None = None, name=None, style: Color | Dict | None = None, layers: Mapping[Any, GeoSeries | GeoDataFrame | BaseGeometry | Iterable[BaseGeometry] | Iterable[Tuple[BaseGeometry, Dict[str, Any]]] | Dict[str, Any] | Iterable[Dict[str, Any]]] | Sequence[Tuple[Any, GeoSeries | GeoDataFrame | BaseGeometry | Iterable[BaseGeometry] | Iterable[Tuple[BaseGeometry, Dict[str, Any]]] | Dict[str, Any] | Iterable[Dict[str, Any]]] | Tuple[Any, GeoSeries | GeoDataFrame | BaseGeometry | Iterable[BaseGeometry] | Iterable[Tuple[BaseGeometry, Dict[str, Any]]] | Dict[str, Any] | Iterable[Dict[str, Any]], Color | Dict]] | None = None, layers_style: Mapping[Any, Color | Dict] | None = None, tiles: Series | Iterable[int] | None = None, tiles_style: Color | Dict | None = None, center: Point | None = None, zoom: int | None = None, theme: Theme | None = None)[source]#

Shorthand function to instantiate, configure and show the inspector.

It supports the majority of the features of the inspector. For finer control, please manually instantiate, configure and show() an Inspector implementation.

Parameters:

  • features –

    an optional set of attributed geometries. Supported types: - gpd.GeoSeries, unattributed geometries - gpd.GeoDataFrame, attributes geometries - BaseGeometry, individual geometries - Iterable of BaseGeometry, it can be any container

    but also a Generator of unattributed geometries

    • Iterable of pairs of BaseGeometry and Dict, it can be any container

      but also a Generator of geometries paired with attributes

    • Dict a parsed GeoJSON FeatureCollection or Feature

    • Iterable of parsed GeoJSON Feature, it can be any container

      but also a Generator of parsed GeoJSON features

    • None no single set of features is rendered

  • name – the name of features, used as layer name.

  • style – an optional style for the features. If not present, a default one is picked. It can be a generic inspector style, as defined in here.inspector.styles, or directly a style dictionary, compatible with the inspector implementation.

  • layers –

    optional set of layers, each with a set of attributed geometries. It can be a Mapping containing layer names and attributed geometries. It can also be a Sequence of tuples, each with 2 or 3 components: the layer name, the attributed geometries, and an optional style, removing the need to use layers_style. Supported types for the attributed geometries: - gpd.GeoSeries, unattributed geometries - gpd.GeoDataFrame, attributes geometries - Iterable of BaseGeometry, it can be any container

    but also a Generator of unattributed geometries

    • Iterable of pairs of BaseGeometry and Dict, it can be any container

      but also a Generator of geometries paired with attributes

    • Dict a parsed GeoJSON FeatureCollection or Feature

    • Iterable of parsed GeoJSON Feature, it can be any container

      but also a Generator of parsed GeoJSON features

  • layers_style – an optional dictionary with one style per layer: layers not mentioned in the dictionary are styled with a default style. Each style can be a generic inspector style, as defined in here.inspector.styles, or directly a style dictionary, compatible with the inspector implementation.

  • tiles – an optional tiling grid. Supported types: - pd.Series of tile identifiers - Iterable of tile identifiers, it can be any container but also a Generator - None no tiling grid is rendered

  • tiles_style – an optional style for the tiling grid. If not present, a default one is picked. It can be a generic inspector style, as defined in here.inspector.styles, or directly a style dictionary, compatible with the inspector implementation.

  • center – the center point of the map

  • zoom – the zoom level, from 0 to 31

  • theme – the inspector visual theme, default is used if not specified

Returns:

an object renderable by Jupyter

Raises:

ValueError – in case the combination of input parameters is not supported

here.inspector.new_inspector() → Inspector[source]#

Instantiate a new inspector.

Returns:

A new inspector.

Raises:

ValueError – If invalid inspector_class attribute is set in options.

Subpackages#

Submodules#