@vertigis/viewer-spec/messaging/schema/web-ui-operation-definitions.md

VertiGIS Viewer Specification

# operation: ui.confirm
Description: Gets user confirmation by way of a popup box.

Inputs: `ConfirmOperationArgs`

ConfirmOperationArgs properties:
```json
{
  "cancelButtonText": {
    "description": "The text to display on the cancel button.",
    "type": "string"
  },
  "initialPosition": {
    "description": "Where the dialog appears in the app when it is created. Defaults to \"center\" position. Web only."
  },
  "isDraggable": {
    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
    "type": "boolean"
  },
  "message": {
    "description": "The message to be displayed in the dialog.",
    "type": "string"
  },
  "okButtonText": {
    "description": "The text to display on the ok button.",
    "type": "string"
  },
  "title": {
    "description": "The title of the dialog.",
    "type": "string"
  }
}
```

Outputs: `boolean`

---
# operation: ui.get-component-ids
Description: Get the IDs of components in the current layout that are backed by the given model. Most models are used by a single component, but in some cases multiple components can share a model. Web only.

Inputs: `( Model | string )`

Model properties:
```json
{
  "id": {
    "description": "The unique ID for this entity.",
    "type": "string",
    "isRequired": "true"
  },
  "itemType": {
    "description": "The item type for this entity when it participates in an App.",
    "type": "string",
    "isRequired": "true"
  }
}
```

Outputs: `string[]`

---
# operation: ui.get-component-state
Description: Gets the state of a component. Web only.

Inputs: `( Model | string )`

Model properties:
```json
{
  "id": {
    "description": "The unique ID for this entity.",
    "type": "string",
    "isRequired": "true"
  },
  "itemType": {
    "description": "The item type for this entity when it participates in an App.",
    "type": "string",
    "isRequired": "true"
  }
}
```

Outputs: `State`

---
# operation: ui.get-locale
Description: Gets the current locale code for the application. (example: "en", "fr" or "de-AT"). Web only.

Inputs: `None`

Outputs: `string`

---
# operation: ui.get-theme
Description: Gets the active color theme of the viewer. Returns the theme's ID. Web only.

Inputs: `None`

Outputs: `string`

---
# operation: ui.get-themes
Description: Gets all color themes available to the viewer. Returns the theme IDs. Web only.

Inputs: `None`

Outputs: `string[]`

---
# operation: ui.get-visual-state
Description: Gets the visual state of a component. Web only.

Inputs: `( Model | string )`

Model properties:
```json
{
  "id": {
    "description": "The unique ID for this entity.",
    "type": "string",
    "isRequired": "true"
  },
  "itemType": {
    "description": "The item type for this entity when it participates in an App.",
    "type": "string",
    "isRequired": "true"
  }
}
```

Outputs: `string`

---
# operation: ui.prompt
Description: Prompts the user to enter a value in a popup box. Web only.

Inputs: `PromptOperationArgs`

PromptOperationArgs properties:
```json
{}
```

Outputs: `string`

---