Options
All
  • Public
  • Public/Protected
  • All
Menu

Allows to map ExternalGraphic elements in a Symbology Encoding file to icon images.

since

2021.1

Hierarchy

  • IconProvider

Overview

Methods

Methods

getIcon

  • (uri: string): HTMLImageElement | HTMLCanvasElement | string
  • Provides the image or URL to be used for the ExternalGraphic with the given URI. If this provider does not specify a custom image for the given URI, it should just return the input string again. In this case, the ExternalGraphic will be handled as normal.

    Parameters

    • uri: string

      the URI value as defined in the href of an ExternalGraphics's OnlineResource or its InlineContent. In case of the latter, the full URL is provided including the format, for example: "data:image/png;base64,xxx".

    Returns HTMLImageElement | HTMLCanvasElement | string

    the image to be used as icon, or a URL pointing to the image.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method