Interface HighlighterFactory

Factory to create new Highlighter instances. It can be injected as a component via "highlights.HighlighterFactory".

Hierarchy

  • HighlighterFactory

Methods

  • Returns a new Highlighter instance for the given map widget model.

    Parameters

    • mapWidgetModel: MapWidgetModel

      The map widget model on which highlights should be drawn.

    • Optional options: HighlighterFactoryOptions

      additional options

    Returns Highlighter

    Example

    highlighter for mapwidget model ```js // inject factory as `highlights.HighlighterFactory` // inject model as `map-widget.MapWidgetModel` const highlighter = factory.forMapWidgetModel(model) highlighter.highlight({ geometry, attributes, symbol, context }); // later clean up highlighter.destroy(); ```

    Example

    highlighter using custom collection ```js const glayer = new GraphicsLayer(); const graphics = glayer.graphics; const highlighter = factory.forMapWidgetModel(model, { graphicsCollectionResolver: (model) => graphics }); // now highlights are added to the custom GraphicsLayer. ```

Generated using TypeDoc