Class OverlayTextProvider`Abstract`

A utility class that can be used to implement a UI component that shows an overlay text for a layer, for example an overlay that shows the current MGRS grid zone.

The text can be based on the following types of coordinates:

a fixed pixel coordinate, for example the center of the map
the coordinate under the mouse, see OverlayTextCoordinateType.MOUSE_CURSOR
a (part of) the coordinate that is common for all points on the map, see OverlayTextCoordinateType.COMMON_MAP_COORDINATE

This utility fires events whenever the text changes, or the visibility of the layer changes. You can use these events to update the state of your UI component.

Since

2022.0

Hierarchy (View Summary)

OverlayTextProvider
- MGRSGridOverlayTextProvider

Implements

Evented

Index

Constructors

constructor

new OverlayTextProvider(
    layer: Layer,
    settings: OverlayTextSetting[],
    defaultFormat: string,
    options?: OverlayTextProviderConstructorOptions,
): OverlayTextProvider
Constructs a new OverlayTextProvider
Parameters
- layer: Layer
  The layer to provide overlay text for
- settings: OverlayTextSetting[]
  Specifies what format string to use at what scale range
- defaultFormat: string
  The default format string. This is used if no format string was found for the current scale.
- Optionaloptions: OverlayTextProviderConstructorOptions
  Options for this OverlayTextProvider.
Returns OverlayTextProvider

Accessors

text

get text(): string
Returns the current overlay text. This changes whenever coordinate specified by OverlayTextProviderConstructorOptions.coordinate changes. Ie. the map is moved (or the mouse moves if OverlayTextCoordinateType.MOUSE_CURSOR.

Returns string

visible

get visible(): boolean
Returns the current state of visibility. Visible is true when:
- the layer is added to a map
- the layer's Layer.visible is true
- labeling is turned on for the current layer
Returns boolean

Methods

destroy

destroy(): void
Destroy this OverlayTextProvider. This cleans up all map / layer listeners it has set up.

Returns void

`Protected` `Abstract`formatCommonMapCoordinate

formatCommonMapCoordinate(map: RIAMap, format: string): string
Called whenever a common map coordinate (OverlayTextCoordinateType.COMMON_MAP_COORDINATE) needs to be formatted to a string.
Parameters
- map: RIAMap
  A reference to the map for which to determine the common map coordinate.
- format: string
  The format string to use. This is the format string that matches the current scale range (as passed into the constructor), or the default format string if no matching scale range was found.
Returns string

`Protected` `Abstract`formatModelPoint

formatModelPoint(modelPoint: Point, format: string): string
Called whenever a single (model) point needs to be formatted to a string.
Parameters
- modelPoint: Point
  The point to format to a string
- format: string
  The format string to use. This is the format string that matches the current scale range (as passed into the constructor), or the default format string if no matching scale range was found.
Returns string

`Protected`update

update(): void
Call this to update text. For example, this is called when the map is moved.

Returns void

`Protected`viewPointToModel

viewPointToModel(viewPoint: Point): Point
Protected
Transform a view point (pixels) to the model reference
Parameters
- viewPoint: Point
  A view point (pixel coordinaes) to transform to the model reference
Returns Point

Events

on

on(event: "TextChanged", callback: (newText: string) => void): Handle
This event fires whenever OverlayTextProvider.text changes.
Parameters
- event: "TextChanged"
- callback: (newText: string) => void
Returns Handle
Implementation of Evented.on
on(
event: "VisibilityChanged",
callback: (newVisibility: boolean) => void,
): Handle
This event fires whenever OverlayTextProvider.visible changes.
Parameters
- event: "VisibilityChanged"
- callback: (newVisibility: boolean) => void
Returns Handle
Implementation of Evented.on

Class OverlayTextProvider`Abstract`

Since

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns OverlayTextProvider

Accessors

text

Returns string

visible

Returns boolean

Methods

destroy

Returns void

`Protected` `Abstract`formatCommonMapCoordinate

Parameters

Returns string

`Protected` `Abstract`formatModelPoint

Parameters

Returns string

`Protected`update

Returns void

`Protected`viewPointToModel

Parameters

Returns Point

Events

on

Parameters

Returns Handle

Parameters

Returns Handle

Settings

On This Page

Class OverlayTextProviderAbstract

Since

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns OverlayTextProvider

Accessors

text

Returns string

visible

Returns boolean

Methods

destroy

Returns void

Protected AbstractformatCommonMapCoordinate

Parameters

Returns string

Protected AbstractformatModelPoint

Parameters

Returns string

Protectedupdate

Returns void

ProtectedviewPointToModel

Parameters

Returns Point

Events

on

Parameters

Returns Handle

Parameters

Returns Handle

Settings

On This Page

Class OverlayTextProvider`Abstract`

`Protected` `Abstract`formatCommonMapCoordinate

`Protected` `Abstract`formatModelPoint

`Protected`update

`Protected`viewPointToModel