add doc for vertical view of custom api
This commit is contained in:
parent
268e80a8d1
commit
cd7513b7b6
@ -16,6 +16,7 @@ widget:
|
|||||||
password: password # auth - optional
|
password: password # auth - optional
|
||||||
method: GET # optional, e.g. POST
|
method: GET # optional, e.g. POST
|
||||||
headers: # optional, must be object, see below
|
headers: # optional, must be object, see below
|
||||||
|
vertical: # optional, default to false, see below
|
||||||
mappings:
|
mappings:
|
||||||
- field: key # needs to be YAML string or object
|
- field: key # needs to be YAML string or object
|
||||||
label: Field 1
|
label: Field 1
|
||||||
@ -113,6 +114,32 @@ You can manipulate data with the following tools `remap`, `scale` and `suffix`,
|
|||||||
suffix: kW
|
suffix: kW
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Vertical View
|
||||||
|
|
||||||
|
You can change the default block view to a list view (similar to the Coin Market Cap widget) by setting the `vertical` option to `true`. The list view extends vertically to the proper height.
|
||||||
|
|
||||||
|
For those who set the `vertical` option to `true`, there are two optional parameters to add to the `mappings` section: `currency` and `trend`.
|
||||||
|
|
||||||
|
- `currency`: Specifies a currency symbol to be added in front of the field value.
|
||||||
|
- `trend`: Adds a colored trend indicator with a percentage sign. The value for the `trend` field needs to be a key similar to `field`.
|
||||||
|
|
||||||
|
**Note:** Data transformation is still compatible with the list view, but the transformation only applies to the value of the `field`.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- field: key
|
||||||
|
label: Field
|
||||||
|
format: text
|
||||||
|
trend: trend_key # optional
|
||||||
|
currency: USD # optional
|
||||||
|
remap:
|
||||||
|
- value: 0
|
||||||
|
to: None
|
||||||
|
- value: 1
|
||||||
|
to: Connected
|
||||||
|
- any: true # will map all other values
|
||||||
|
to: Unknown
|
||||||
|
```
|
||||||
|
|
||||||
## Custom Headers
|
## Custom Headers
|
||||||
|
|
||||||
Pass custom headers using the `headers` option, for example:
|
Pass custom headers using the `headers` option, for example:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user