Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayerHyperlink

Client representation of a layer hyperlink object attached to a layer.

Hierarchy

  • LayerHyperlink

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the LayerHyperlink class.

    Parameters

    • layerHyperlinkInfo: object

      Values used to populate the members of this object.

      • encodeUriReplacementValues: boolean
      • iconUri: string
      • target: string
      • text: string
      • toolTip: string
      • uri: string
    • layerOrMapService: LayerHyperLinkLayer | LayerHyperLinkMapService

    Returns LayerHyperlink

Properties

encodeUriReplacementValues

encodeUriReplacementValues: boolean

Whether to URL encode replacement values in the uri property.

iconUri

iconUri: string

The URI of an image which represents the hyperlink being generated.

layer

layer: LayerHyperLinkLayer

The {@link geocortex.essentials.Layer} that this LayerHyperlink belongs to. Only has a value when this LayerHyperlink was constructed directly on a layer.

mapService

mapService: LayerHyperLinkMapService

The {@link geocortex.essentials.MapService} that this Layerhyperlink belongs to.

target

target: string

The name of the target browser window which the hyperlink result will populate (e.g., _blank).

text

text: string

The text to display in place of the hyperlink URI.

toolTip

toolTip: string

The information shown to the user when the hyperlink is hovered over.

uri

uri: string

A URI format string which can be used to dynamically insert field values within the URI.

Methods

toJson

  • toJson(): object

  • Exports the state of the hyperlink as a JSON object. This can be used to recreate the hyperlink again via the constructor.

    Returns object