Interface IconProvider

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

Since

2021.1

interface IconProvider {
getIcon(uri: string): string | HTMLImageElement | HTMLCanvasElement;
}

Index

Methods

Methods

getIcon

getIcon(uri: string): string | HTMLImageElement | HTMLCanvasElement
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 the latter case, the full URL is provided including the format, for example: "data:image/png;base64,xxx".
Returns string | HTMLImageElement | HTMLCanvasElement
the image to be used as icon, or a URL pointing to the image.