Interface Highlights

Manages highlights on the map.

interface Highlights {
    "[DESTROY_HIGHLIGHTS]"(): void;
    "[GET_HIGHLIGHT_LAYER]"(): VectorLayer<
        VectorSource<Feature<Geometry, { [x: string]: any }>>,
        Feature<Geometry, { [x: string]: any }>,
    >;
    add(displayTargets: DisplayTarget[], options?: HighlightOptions): Highlight;
    addAndZoom(
        displayTarget: DisplayTarget[],
        options?: HighlightZoomOptions,
    ): Highlight;
    clear(): void;
}

Index

Methods

[DESTROY_HIGHLIGHTS] [GET_HIGHLIGHT_LAYER] add addAndZoom clear

Methods

[DESTROY_HIGHLIGHTS]

"[DESTROY_HIGHLIGHTS]"(): void
Returns void
- Defined in src/packages/map/model/Highlights.ts:107

[GET_HIGHLIGHT_LAYER]

"[GET_HIGHLIGHT_LAYER]"(): VectorLayer<
VectorSource<Feature<Geometry, { [x: string]: any }>>,
Feature<Geometry, { [x: string]: any }>,
>
Returns the layer used for highlights.

Returns VectorLayer<
VectorSource<Feature<Geometry, { [x: string]: any }>>,
Feature<Geometry, { [x: string]: any }>,
>
- Defined in src/packages/map/model/Highlights.ts:188

add

add(displayTargets: DisplayTarget[], options?: HighlightOptions): Highlight
Creates a highlight at the given targets.

A highlight is a temporary graphic on the map that calls attention to a point or an area.

Call destroy() on the returned highlight object to remove the highlight.
Parameters
- displayTargets: DisplayTarget[]
- Optionaloptions: HighlightOptions
Returns Highlight
- Defined in src/packages/map/model/Highlights.ts:118

addAndZoom

addAndZoom(
displayTarget: DisplayTarget[],
options?: HighlightZoomOptions,
): Highlight
Creates a highlight and zooms to the given targets.

See also add and MapModel.zoom.
Parameters
- displayTarget: DisplayTarget[]
- Optionaloptions: HighlightZoomOptions
Returns Highlight
- Defined in src/packages/map/model/Highlights.ts:167

clear

clear(): void
This method destroys all active Highlights.

Returns void
- Defined in src/packages/map/model/Highlights.ts:179

Interface Highlights

Index

Methods

Methods

[DESTROY_HIGHLIGHTS]

Returns void

[GET_HIGHLIGHT_LAYER]

Returns VectorLayer<
VectorSource<Feature<Geometry, { [x: string]: any }>>,
Feature<Geometry, { [x: string]: any }>,
>

add

Parameters

Returns Highlight

addAndZoom

Parameters

Returns Highlight

clear

Returns void

Settings

On This Page

Interface Highlights

Index

Methods

Methods

[DESTROY_HIGHLIGHTS]

Returns void

[GET_HIGHLIGHT_LAYER]

Returns VectorLayer< VectorSource<Feature<Geometry, { [x: string]: any }>>, Feature<Geometry, { [x: string]: any }>,>

add

Parameters

Returns Highlight

addAndZoom

Parameters

Returns Highlight

clear

Returns void

Settings

On This Page

Returns VectorLayer<
VectorSource<Feature<Geometry, { [x: string]: any }>>,
Feature<Geometry, { [x: string]: any }>,
>