react-leaflet-ellipsis v1.9.13

Import Ellipsis layers in react-leaflet

Install

Install using npm install react-leaflet-ellipsis

Usage

In a React app, import the RasterLayer and VectorLayer: import { EllipsisRasterLayer } from 'react-leaflet-ellipsis' import { EllipsisVectorLayer } from 'react-leaflet-ellipsis' import { EllipsisApi } from 'react-leaflet-ellipsis'

Example

You can use RasterLayer and VectorLayer within a <MapContainer /> or <Map /> component.

<MapContainer>
  <EllipsisRasterLayer pathId={pathId} />
  <EllipsisVectorLayer pathId={pathId} />
</MapContainer>

To request metadata of Ellipsis Drive layers you can use the function available in the EllipsisApi.

useEffect(() => {
  EllipsisApi.getMetadata(mapId).then((response) => {
    console.log(response);
  });
}, []);

If the Ellipsis Drive layers you wish to use are not set to public or linksharing you need to create a token for your app. See here for how to obtain such a token.

RasterLayer props

note for the style object, refer to this documentation about it.

VectorLayer props

warning loadAll=true will ignore maxMbPerTile, maxTilesInCache and maxFeaturesPerTile settings.

note for the style object, refer to this documentation about it.

Fetching metadata

#### EllipsisApi.getPath description

**parameters**

| name   | description                                                                       |
| ------ | --------------------------------------------------------------------------------- |
| pathId | The id of the path.                                                               |
| user   | (Optional) An user object which can contain a token like `user: {token: mytoken}` |

**return value**
It returns JSON, which depends on the type of the specified object.