From 92cc9dafedb2683ead5b0acbd3294919db41f43a Mon Sep 17 00:00:00 2001 From: robin Date: Sun, 11 Jun 2023 11:03:36 +0000 Subject: [PATCH] dashbaord updates documented! --- api/collections/medialib.yml | 3 +++ docs/md/projektkonfig/dashboard.md | 43 ++++++++++++++++++++++++------ 2 files changed, 38 insertions(+), 8 deletions(-) diff --git a/api/collections/medialib.yml b/api/collections/medialib.yml index 6ff1c3f..2e3d142 100644 --- a/api/collections/medialib.yml +++ b/api/collections/medialib.yml @@ -17,6 +17,9 @@ meta: # Die Bildgröße für die Einbindung ins erzeugte HTML des ContentBuilder # hat hiermit nix zu tun. 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 # "subNavigation" Index definiert, werden auch folgende "views" diff --git a/docs/md/projektkonfig/dashboard.md b/docs/md/projektkonfig/dashboard.md index 765cece..b53a7a0 100644 --- a/docs/md/projektkonfig/dashboard.md +++ b/docs/md/projektkonfig/dashboard.md @@ -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. - ˋ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ˋ 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. -## 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 @@ -153,7 +172,6 @@ dashboard: title: "Overview" #i18n or eval - type: swiper - containerProps: class: "random-class" layout: @@ -170,6 +188,8 @@ dashboard: value: total valueType: absolute #oder relative (prozentual) 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 field: paymentValue title: toller titel #string or eval @@ -247,6 +267,8 @@ dashboard: subTitle: { de: "Umsatz", en: "sales volume" } # Untertitel des Graphen, mehrsprachig xAxis: timeline # Art der x-Achse, hier eine Zeitachse class: "random-class" #Class added + additionalApiParams: + limit: 2 containerProps: #optional class prop layout: @@ -440,12 +462,11 @@ dashboard: default: "col-8" small: "col-12" large: "col-7" - - # uses dashboardTable and dashboarSimpleList inside the collection collection: contact_form title: Konaktformular Titel 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 type: reference # Art des Elements, hier ein Referenz-Element @@ -457,7 +478,8 @@ dashboard: style: upper: rgba(3, 50, 59, 0.7) lower: rgba(3, 50, 59) - - collection: content + - collection: contact_form + subNavigation: 1 type: reference style: upper: rgba(3, 50, 59, 0.7) @@ -465,10 +487,15 @@ dashboard: minorItems: # Liste der Nebenelemente des Dashboards - collection: contact_form # Referenz auf collections + subNavigation: 0 - collection: contact_form # Wiederholung der vorherigen Nebenelemente + subNavigation: 0 - collection: contact_form + subNavigation: 0 - collection: contact_form + subNavigation: 0 - collection: contact_form + subNavigation: 0 - collection: contact_form ```