Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions docs/user-guide/020-manager-ui/30-appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,10 @@ By default Superusers (e.g. the 'admin' user of the master realm) will see these
```

</details>
**Realm configuration:** You can set the branding per realm. In the example below you can see how the page title, headers, colors, and logos are set as default (for any new realm created through the UI), as well as for the 'master' and 'clienta' realms.

### Realm Configuration

You can set the branding per realm. In the example below you can see how the page title, headers, colors, and logos are set as default (for any new realm created through the UI), as well as for the 'master' and 'clienta' realms.
```json
{
"realms": {
Expand Down Expand Up @@ -316,7 +319,11 @@ By default Superusers (e.g. the 'admin' user of the master realm) will see these
This is what the --or-app-colors look like in the demo deployment:
![Default colors in OpenRemote](img/or-app-colors.jpg)

**Assets - tree:** Exclude asset types from the 'Add asset' dialog.
### Assets

#### Tree Configuration

Exclude asset types from the 'Add asset' dialog.
```json
{
"pages": {
Expand Down Expand Up @@ -347,7 +354,9 @@ This is what the --or-app-colors look like in the demo deployment:
}
}
```
**Assets - viewer:** Configure which panels are shown on the assets page. You can include or exclude attributes to show per panel. These panels can be set for all asset types, or specified per type. This is an overwrite of the default config of the [asset-viewer](https://github.com/openremote/openremote/blob/master/ui/component/or-asset-viewer/src/index.ts). In `historyConfig` an example is given on how to specify the columns shown in a table for an attribute that is not a number or boolean; if no config is given, it will automatically create columns.
#### Viewer Configuration

Configure which panels are shown on the assets page. You can include or exclude attributes to show per panel. These panels can be set for all asset types, or specified per type. This is an overwrite of the default config of the [asset-viewer](https://github.com/openremote/openremote/blob/master/ui/component/or-asset-viewer/src/index.ts). In `historyConfig` an example is given on how to specify the columns shown in a table for an attribute that is not a number or boolean; if no config is given, it will automatically create columns.
```json
{
"pages": {
Expand Down Expand Up @@ -460,7 +469,10 @@ This is what the --or-app-colors look like in the demo deployment:
}
}
```
**Rules - Controls:**
### Rules

#### Controls Configuration

Set which types of rules are available (for users with the correct permissions), and which actions a rule can perform.
```json
{
Expand All @@ -485,7 +497,8 @@ Set which types of rules are available (for users with the correct permissions),
}
}
```
**Rules - When-Then:**
#### When-Then Configuration

Set which asset types are excluded from the list of asset types that can be selected in the When-Then rule. Additionally you can set per asset (or all '*') which attributes should be excluded from the select list.
```json
{
Expand Down Expand Up @@ -513,7 +526,10 @@ Set which asset types are excluded from the list of asset types that can be sele
}
}
```
**Map - Card:**
### Map

#### Card Configuration

You can set the attributes to exclude (or include) on the top right card of the map when an asset is selected. This can be done for all asset types (by using default), or per asset type (as shown for WeatherAsset).
```json
{
Expand All @@ -540,7 +556,8 @@ You can set the attributes to exclude (or include) on the top right card of the
}
}
```
**Map - Marker config:**
#### Marker Configuration

This configures how the markers behave. They can either change their colour based on an attribute value (number, boolean, or string), show a label with or without units, and/or show the direction an asset is facing. Note that this part of the config is not yet configured in the manager_config of the manager demo.
```json
{
Expand Down Expand Up @@ -574,7 +591,8 @@ This configures how the markers behave. They can either change their colour base
}
}
```
**Map - Clustering config:**
#### Clustering Configuration

This configures how clustering behaves. Clustering ensures the map page can render assets smoothly even with 40-50 thousand assets. The clustering option can be disabled, or changed to cluster markers in a smaller radius showing more clusters and changed to start clustering at a certain zoom level. Note that reducing cluster radius or cluster max zoom can have performance impacts. The recommended cluster max zoom level is Maximum realm zoom level - 2.
```json
{
Expand All @@ -589,7 +607,8 @@ This configures how clustering behaves. Clustering ensures the map page can rend
}
}
```
**Map - Legend config:**
#### Legend Configuration

This configures what asset types are shown as markers on the map. The legend is enabled by default and can be disabled by setting show to false.
```json
{
Expand All @@ -603,7 +622,8 @@ This configures what asset types are shown as markers on the map. The legend is
}
```

**Map - Preset filters:**
#### Preset Filters Configuration

This configures map preset filters, which add a dropdown on the map page to quickly filter the visible assets by type, attribute values, realm, and more using an `AssetQuery`. A live matching-asset count badge is shown per filter option. Options without a `label` will have an auto-derived label based on the type names and attribute values. Selected filters are persisted across page reloads (per user and realm) and reset on each new login session. You can also specify an optional `default` boolean or an array of `realms` to limit where the filter applies. Note that unsupported query fields like `orderBy`, `limit`, and `offset` will result in a warning.
```json
{
Expand Down