9.0 KiB
Untitled object in Dashy Config Schema Schema
https://example.com/schemas/abstract#/properties/sections/items/properties/displayData
Optional meta data for customizing a section
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | dashy-config.schema.json* |
displayData Type
object (Details)
displayData Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| collapsed | boolean |
Optional | cannot be null | Dashy Config Schema |
| color | string |
Optional | cannot be null | Dashy Config Schema |
| customStyles | string |
Optional | cannot be null | Dashy Config Schema |
| itemSize | Not specified | Optional | cannot be null | Dashy Config Schema |
| rows | number |
Optional | cannot be null | Dashy Config Schema |
| cols | number |
Optional | cannot be null | Dashy Config Schema |
| layout | Not specified | Optional | cannot be null | Dashy Config Schema |
| itemCountX | number |
Optional | cannot be null | Dashy Config Schema |
| itemCountY | number |
Optional | cannot be null | Dashy Config Schema |
collapsed
If true, section needs to be clicked to open
collapsed
-
is optional
-
Type:
boolean -
cannot be null
-
defined in: Dashy Config Schema
collapsed Type
boolean
color
Hex code, or HTML color for section fill
color
-
is optional
-
Type:
string -
cannot be null
-
defined in: Dashy Config Schema
color Type
string
customStyles
CSS overides for section container
customStyles
-
is optional
-
Type:
string -
cannot be null
-
defined in: Dashy Config Schema
customStyles Type
string
itemSize
Size of items within the section
itemSize
-
is optional
-
Type: unknown
-
cannot be null
-
defined in: Dashy Config Schema
itemSize Type
unknown
itemSize Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"small" |
|
"medium" |
|
"large" |
itemSize Default Value
The default value is:
"medium"
rows
The amount of space that the section spans vertically
rows
-
is optional
-
Type:
number -
cannot be null
-
defined in: Dashy Config Schema
rows Type
number
rows Constraints
maximum: the value of this number must smaller than or equal to: 5
minimum: the value of this number must greater than or equal to: 1
rows Default Value
The default value is:
1
cols
The amount of space that the section spans horizontally
cols
-
is optional
-
Type:
number -
cannot be null
-
defined in: Dashy Config Schema
cols Type
number
cols Constraints
maximum: the value of this number must smaller than or equal to: 5
minimum: the value of this number must greater than or equal to: 1
cols Default Value
The default value is:
1
layout
If set to grid, items have uniform width, and itemCount can be set
layout
-
is optional
-
Type: unknown
-
cannot be null
-
defined in: Dashy Config Schema
layout Type
unknown
layout Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"grid" |
|
"auto" |
layout Default Value
The default value is:
"auto"
itemCountX
Number of items per column
itemCountX
-
is optional
-
Type:
number -
cannot be null
-
defined in: Dashy Config Schema
itemCountX Type
number
itemCountX Constraints
maximum: the value of this number must smaller than or equal to: 12
minimum: the value of this number must greater than or equal to: 1
itemCountY
Number of items per row
itemCountY
-
is optional
-
Type:
number -
cannot be null
-
defined in: Dashy Config Schema
itemCountY Type
number
itemCountY Constraints
maximum: the value of this number must smaller than or equal to: 12
minimum: the value of this number must greater than or equal to: 1