UI
The UI API lets you interact with the Qatium UI.
sendMessage()
Section titled “sendMessage()”Allows the plugin to communicate with its UI panel.
Method signature
Section titled “Method signature”sendMessage<T>(message: T): voidParameters
Section titled “Parameters”message: T: an arbitrary message to be sent to the UI. Check the documentation of structuredClone to verify what can be sent.
Example
Section titled “Example”Send a message to the UI panel
const numOfValves = sdk.network.getValves().lengthsdk.ui.sendMessage(numOfValves)isMapView()
Section titled “isMapView()”Returns true if map view mode is active, or false if it isn’t.
Method signature
Section titled “Method signature”isMapView(): booleanisSynopticView()
Section titled “isSynopticView()”Returns true if synoptic view mode is active, or false if it isn’t.
Method signature
Section titled “Method signature”isSynopticView(): booleanisPanelOpen()
Section titled “isPanelOpen()”Returns true is the plugin’s panel is open, or false if it isn’t.
Method signature
Section titled “Method signature”isPanelOpen(): booleanopenPanel()
Section titled “openPanel()”Opens the plugin’s panel.
Method signature
Section titled “Method signature”openPanel()closePanel()
Section titled “closePanel()”Closes the plugin’s panel.
Method signature
Section titled “Method signature”closePanel()isPluginVisible()
Section titled “isPluginVisible()”Returns true if the plugin’s overlay is visible, or false if it isn’t.
Method signature
Section titled “Method signature”isPluginVisible(): booleanisMapLayerVisible()
Section titled “isMapLayerVisible()”Returns true if the layer for the AssetType is visible in the map.
Method signature
Section titled “Method signature”isMapLayerVisible: ( type: AssetType, layer?: ValveGroup | JunctionGroup | PipeGroup): booleangetLanguage()
Section titled “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
Section titled “Method signature”getLanguage(): "es" | "en" | "pt"