UI

The UI API lets you interact with the Qatium UI.

sendMessage()

Allows the plugin to communicate with its UI panel.

Method signature

TypeScript

sendMessage<T>(message: T): void

Parameters

• message: T: an arbitrary message to be sent to the UI. Check the documentation of structuredClone to verify what can be sent.

Example

Send a message to the UI panel

TypeScript

const numOfValves = sdk.network.getValves().length
sdk.ui.sendMessage(numOfValves)

isMapView()

Returns true if map view mode is active, or false if it isn’t.

Method signature

TypeScript

isMapView(): boolean

isSynopticView()

Returns true if synoptic view mode is active, or false if it isn’t.

Method signature

TypeScript

isSynopticView(): boolean

isPanelOpen()

Returns true is the plugin’s panel is open, or false if it isn’t.

Method signature

TypeScript

isPanelOpen(): boolean

openPanel()

Opens the plugin’s panel.

Method signature

TypeScript

openPanel()

closePanel()

Closes the plugin’s panel.

Method signature

TypeScript

closePanel()

isPluginVisible()

Returns true if the plugin’s overlay is visible, or false if it isn’t.

Method signature

TypeScript

isPluginVisible(): boolean

isMapLayerVisible()

Returns true if the layer for the AssetType is visible in the map.

Method signature

TypeScript

isMapLayerVisible: (
  type: AssetType,
  layer?: ValveGroup | JunctionGroup | PipeGroup
): boolean

getLanguage()

Returns a string representing the ISO 639 language code of the user’s preferred language in the browser. Currently supports Spanish, English and Portuguese.

Method signature

TypeScript

getLanguage(): "es" | "en" | "pt"