Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClickableGraphicsRegistry

Central management component for creating and accessing clickable graphics from any module across the viewer.

Hierarchy

  • ClickableGraphicsRegistry

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the ClickableGraphicsRegistry class.

    Parameters

    • app: ViewerApplication

      The {@link geocortex.essentialsHtmlViewer.ViewerApplication} that this instance belongs to.

    Returns ClickableGraphicsRegistry

Properties

app

app: ViewerApplication

The {@link geocortex.essentialsHtmlViewer.ViewerApplication} that this clickable graphics registry belongs to.

Methods

clear

  • clear(): void

  • Unregisters all clickable graphic layers registered in the registry.

    Returns void

getLayerInfo

  • Returns ClickableLayerInfo.

    Parameters

    • graphicsLayer: GraphicsLayer

      The graphic layer to unregister.

    Returns ClickableLayerInfo

    ClickableLayerInfo which Contains information about clickable layer in a map

getLayerInfos

  • Returns an array of ClickableLayerInfos.

    Returns ClickableLayerInfo[]

    array of ClickableLayerInfos which Contains information about clickable layer in a map.

isLayerRegistered

  • isLayerRegistered(graphicsLayer: GraphicsLayer): boolean

  • Checks if a given esri graphic layer is registered to be clickable.

    Parameters

    • graphicsLayer: GraphicsLayer

    Returns boolean

    boolean.

register

  • Registers a graphic layer.

    Parameters

    • graphicsLayer: GraphicsLayer

      The graphic layer to register.

    • Optional options: ClickableOptions

      An optional ClickableOptions pertaining to clickable graphics layer.

    Returns void

unregister

  • unregister(graphicsLayer: GraphicsLayer): void

  • Unregisters a graphic layer.

    Parameters

    • graphicsLayer: GraphicsLayer

      The graphic layer to unregister.

    Returns void