Skip to main content

Workspace Widgets

This design is included in the Apps Workspaces module.

Description​

This design has no description.

Properties​

This design has the following properties.

PropertyValue
NameWorkspace Widgets
Codedesigns_appsWorkspaceWidgets
TypeDesign
ContextModule
AI agent enabledfalse
Icon-
Colour-
Title-
SubtitleWorkspace Widget

Implements​

This design implements the following interfaces.

NameCode
App EntitiesdesignInterfaces_appEntities

Attributes​

This design has the following attributes. It may also inherit attributes from any of the interfaces it implements.

Configuration​

PropertyValue
NameConfiguration
Codeattributes_appsWorkspaceWidgetsConfiguration
TypeJson
Requiredtrue
Uniquefalse
Read-onlyfalse
AI agent enabledfalse
Options
Show options (345 lines)
{
"jsonSchema": {
"anyOf": [
{
"type": "object",
"properties": {
"hasBars": {
"type": "boolean"
},
"map": {
"type": "object",
"properties": {
"basemap": {
"type": "string"
},
"layers": {
"type": "array",
"items": {
"type": "string"
}
},
"boundingBox": {
"type": "array",
"minItems": 4,
"maxItems": 4,
"items": {
"type": "number",
"minimum": -180,
"maximum": 180
}
}
},
"additionalProperties": false
},
"defaultApp": {
"type": "string"
},
"type": {
"type": "string",
"const": "Board"
},
"boardId": {
"type": "string"
},
"aqsParameterValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {}
},
"required": [
"name",
"value"
],
"additionalProperties": false
}
},
"dataPoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"colour": {
"type": "string"
}
},
"required": [
"icon",
"colour"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "BoardColumn"
},
"columnId": {
"type": "string"
}
},
"required": [
"id",
"name",
"style",
"type",
"columnId"
],
"additionalProperties": false
}
}
},
"required": [
"hasBars",
"type",
"boardId",
"dataPoints"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"hasBars": {
"type": "boolean"
},
"map": {
"type": "object",
"properties": {
"basemap": {
"type": "string"
},
"layers": {
"type": "array",
"items": {
"type": "string"
}
},
"boundingBox": {
"type": "array",
"minItems": 4,
"maxItems": 4,
"items": {
"type": "number",
"minimum": -180,
"maximum": 180
}
}
},
"additionalProperties": false
},
"defaultApp": {
"type": "string"
},
"type": {
"type": "string",
"const": "Standard"
},
"dataPoints": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"colour": {
"type": "string"
}
},
"required": [
"icon",
"colour"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "CustomQuery"
},
"aqs": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"id",
"name",
"style",
"type",
"aqs"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"colour": {
"type": "string"
}
},
"required": [
"icon",
"colour"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "LayerStyle"
},
"layerCode": {
"type": "string"
},
"styleId": {
"type": "string"
}
},
"required": [
"id",
"name",
"style",
"type",
"layerCode",
"styleId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"colour": {
"type": "string"
}
},
"required": [
"icon",
"colour"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "List"
},
"listId": {
"type": "string"
}
},
"required": [
"id",
"name",
"style",
"type",
"listId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"style": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"colour": {
"type": "string"
}
},
"required": [
"icon",
"colour"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "SavedQuery"
},
"queryId": {
"type": "string"
}
},
"required": [
"id",
"name",
"style",
"type",
"queryId"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"hasBars",
"type",
"dataPoints"
],
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
}
}

Standard paths​

This design doesn't have any standard paths of its own. However, it may inherit standard paths from any of the interfaces it implements.

Permissions​

This design defines the following permissions.

User groupAllowed
Apps Workspaces ViewersRead
Apps Workspaces ManagersRead, Create, Edit, Delete

Default attribute permissions​

This design applies the following default permissions to all attributes for the following user groups.

AllowedUser groupCode
ReadOnlyApps Workspaces ViewersuserGroups_appsWorkspacesViewers
ReadWriteApps Workspaces ManagersuserGroups_appsWorkspacesManagers