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

Python

send_message(message: Any)

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)

Python

num_of_valves = len(sdk.network.get_valves())
sdk.ui.send_message(num_of_valves)

isMapView()

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

Method signature

TypeScript

isMapView(): boolean

Python

is_map_view() -> bool

isSynopticView()

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

Method signature

TypeScript

isSynopticView(): boolean

Python

is_synoptic_view() -> bool

isPanelOpen()

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

Method signature

TypeScript

isPanelOpen(): boolean

Python

is_panel_open() -> bool

openPanel()

Opens the plugin’s panel.

Method signature

TypeScript

openPanel()

Python

open_panel()

closePanel()

Closes the plugin’s panel.

Method signature

TypeScript

closePanel()

Python

close_panel()

isPluginVisible()

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

Method signature

TypeScript

isPluginVisible(): boolean

Python

is_plugin_visible() -> bool

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

Python

is_map_layer_visible(
    type: Literal['Pipe', 'Junction', 'Valve', 'Pump', 'SupplySource', 'Tank'],
    layer: Optional[Literal['regulating', 'shutOff', 'hydrant', 'junction', 'supplySource', 'main', 'lateral']]
) -> bool

getLanguage()

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

Method signature

TypeScript

getLanguage(): "es" | "en"

Python

get_language() -> Literal['es', 'en']