Interface HighlighterFactory

forMapWidgetModel

• forMapWidgetModel(
      mapWidgetModel: MapWidgetModel,
      options?: HighlighterFactoryOptions,
  ): Highlighter

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

  Parameters

  • mapWidgetModel: MapWidgetModel

    The map widget model on which highlights should be drawn.
  • Optionaloptions: HighlighterFactoryOptions

    additional options

  Returns Highlighter

  Example: <caption>highlighter for mapwidget model</caption>

  // inject factory as `highlights.HighlighterFactory`
  // inject model as `map-widget.MapWidgetModel`
  const highlighter = factory.forMapWidgetModel(model);
  highlighter.highlight(graphic);
  // later clean up
  highlighter.destroy();
  Copy

  Example: <caption>highlighter using custom collection</caption>

  const graphicsLayer = new GraphicsLayer();
  const graphics = graphicsLayer.graphics;
  const highlighter = factory.forMapWidgetModel(model, { graphicsCollectionResolver: (model) => graphics });
  // now highlights are added to the custom GraphicsLayer.
  Copy