dashbaord updates documented!

This commit is contained in:
Robin Grenzdörfer 2023-06-11 11:03:36 +00:00
parent 068681ab79
commit 8c7eca8d0f
2 changed files with 38 additions and 8 deletions

View File

@ -17,6 +17,9 @@ meta:
# Die Bildgröße für die Einbindung ins erzeugte HTML des ContentBuilder # Die Bildgröße für die Einbindung ins erzeugte HTML des ContentBuilder
# hat hiermit nix zu tun. # hat hiermit nix zu tun.
defaultImageFilter: s defaultImageFilter: s
multiupload:
fields: #specify wich fields should be editable in Modal, if property isnt set, then all fields will automatically be selected
- source: description
# Wird unter "image-/file-/videoSelect" im ContentBuilder Feld kein # Wird unter "image-/file-/videoSelect" im ContentBuilder Feld kein
# "subNavigation" Index definiert, werden auch folgende "views" # "subNavigation" Index definiert, werden auch folgende "views"

View File

@ -23,7 +23,7 @@ Der Typ des Dashboard-Elements ist ein entscheidendes Attribut.
Außerdem gibt es den type "comparison", wobei man ein timespan auswählt und dieser timespan und der timespan davor mit einander auf einen bestimmten Wert verglichen werden. Außerdem gibt es den type "comparison", wobei man ein timespan auswählt und dieser timespan und der timespan davor mit einander auf einen bestimmten Wert verglichen werden.
- ˋtableˋ: - ˋtableˋ:
Desweiteren gibt es einen type "table" wobei mit dem limit attribut gesetzt wird wie viele Einträge von der ausgewählten collection Angezeigt werden sollen. Desweiteren gibt es einen type "table" wobei über das additionalApiParams Objekt mit dem limit attribut gesetzt wird wie viele Einträge von der ausgewählten collection Angezeigt werden sollen. Per Default sind es 5
- ˋsectionTitleˋ - ˋsectionTitleˋ
Der "sectionTitle" type ist wie der name schon sagt, ein Titel für einen Abschnitt vom dashboard Der "sectionTitle" type ist wie der name schon sagt, ein Titel für einen Abschnitt vom dashboard
@ -36,9 +36,28 @@ Der Titel eines Elements ist ein Objekt, das einen eval, value, contentBefore un
Dies ist ein Untertitel für das Dashboard-Element. Dies ist ein Untertitel für das Dashboard-Element.
## limit ## additionalApiParams
Eine Zahl, welche beim type table dafür genutzt wird, anzugeben, wie viele Einträge angezeigt werden sollen Dies ist ein Objekt und kann folgende Parameter haben:
```ts
interface APIParams {
offset?: number
limit?: number
sort?: string
filter?: {
[key: string]: any
}
projection?: string
count?: 1
}
```
Sollte es komntextabhängig bereits automatisch genertierte Filter Objekt attirbute geben, so werden, wenn man welche angibt, seine eigenen über Object.assign zu diesen hinzu gefügt.
## subNavigation
Das Attrbiut bei type: reference dient dazu, den Link zu einer bestimmten subKategorie zu machen. Nimmt den index der gewüpnschten subNavigation als Wert.
## graphType ## graphType
@ -153,7 +172,6 @@ dashboard:
title: "Overview" #i18n or eval title: "Overview" #i18n or eval
- type: swiper - type: swiper
containerProps: containerProps:
class: "random-class" class: "random-class"
layout: layout:
@ -170,6 +188,8 @@ dashboard:
value: total value: total
valueType: absolute #oder relative (prozentual) valueType: absolute #oder relative (prozentual)
path: paymentValues path: paymentValues
additionalApiParams: #Nimmt APIParams entgegen und fügt sie zusätzlich ein, filter Objekt Parameter wird ggf. zum automatisch generierten Assigned, also vorsicht!
limit: 3
dateTimeField: Date dateTimeField: Date
field: paymentValue field: paymentValue
title: toller titel #string or eval title: toller titel #string or eval
@ -247,6 +267,8 @@ dashboard:
subTitle: { de: "Umsatz", en: "sales volume" } # Untertitel des Graphen, mehrsprachig subTitle: { de: "Umsatz", en: "sales volume" } # Untertitel des Graphen, mehrsprachig
xAxis: timeline # Art der x-Achse, hier eine Zeitachse xAxis: timeline # Art der x-Achse, hier eine Zeitachse
class: "random-class" #Class added class: "random-class" #Class added
additionalApiParams:
limit: 2
containerProps: containerProps:
#optional class prop #optional class prop
layout: layout:
@ -440,12 +462,11 @@ dashboard:
default: "col-8" default: "col-8"
small: "col-12" small: "col-12"
large: "col-7" large: "col-7"
# uses dashboardTable and dashboarSimpleList inside the collection
collection: contact_form collection: contact_form
title: Konaktformular Titel title: Konaktformular Titel
subTitle: subtitel oder so subTitle: subtitel oder so
limit: 4 #maximum of returned entries additionalApiParams:
limit: 3
- collection: content # Sammlung, aus der die Daten für das nächste Element stammen - collection: content # Sammlung, aus der die Daten für das nächste Element stammen
type: reference # Art des Elements, hier ein Referenz-Element type: reference # Art des Elements, hier ein Referenz-Element
@ -457,7 +478,8 @@ dashboard:
style: style:
upper: rgba(3, 50, 59, 0.7) upper: rgba(3, 50, 59, 0.7)
lower: rgba(3, 50, 59) lower: rgba(3, 50, 59)
- collection: content - collection: contact_form
subNavigation: 1
type: reference type: reference
style: style:
upper: rgba(3, 50, 59, 0.7) upper: rgba(3, 50, 59, 0.7)
@ -465,10 +487,15 @@ dashboard:
minorItems: # Liste der Nebenelemente des Dashboards minorItems: # Liste der Nebenelemente des Dashboards
- collection: contact_form # Referenz auf collections - collection: contact_form # Referenz auf collections
subNavigation: 0
- collection: contact_form # Wiederholung der vorherigen Nebenelemente - collection: contact_form # Wiederholung der vorherigen Nebenelemente
subNavigation: 0
- collection: contact_form - collection: contact_form
subNavigation: 0
- collection: contact_form - collection: contact_form
subNavigation: 0
- collection: contact_form - collection: contact_form
subNavigation: 0
- collection: contact_form - collection: contact_form
``` ```