GeoLeaf Core API - v3.19.0
    Preparing search index...

    Interface FeatureMatch

    One feature found by LayerDataApi.search.

    Its first three fields — label, lat, lng, and bounds when present — are the shape of an address-search result, deliberately: a search box listing addresses and features side by side, or a route computed to either, needs no second branch. The rest names the feature, so that LayerDataApi.focus can frame and select it.

    interface FeatureMatch {
        label: string;
        lat: number;
        lng: number;
        bounds?: { north: number; south: number; east: number; west: number };
        layerId: string;
        layerLabel: string;
        featureId: string | null;
    }
    Index
    label lat lng bounds? layerId layerLabel featureId
    label: string

    What to display: the first non-empty declared field, else the feature's id.

    lat: number

    Latitude of a position standing for the feature — the point itself, a line's middle vertex, or the centre of anything else's bounding box.

    lng: number

    Longitude of the same position.

    bounds?: { north: number; south: number; east: number; west: number }

    Bounding box of a line or a polygon, to frame it; absent for a point.

    layerId: string

    Layer the feature belongs to.

    layerLabel: string

    That layer's display label.

    featureId: string | null

    The feature's id (properties.id, else id), or null when it carries none — such a feature can be framed from bounds or lat/lng, but not selected.

    Settings
    Member Visibility

    On This Page
    Properties