Konfigurationsreferenz für Community-Visualisierungen

Die Visualisierungskonfiguration definiert die Daten und Stilattribute, die für eine Visualisierung.

Die Konfiguration wird als JSON-Datei mit folgender Struktur erwartet:

{
  "data": [{
    "id": string,
    "label": string,
    "elements": [{
      "type": enum(DataElement),
      "id": string,
      "label": string,
      "options": object(DataElementOptions)
    }]
  }],
  "style": [{
    "id": string,
    "label": string,
    "elements": [{
      "type": enum(StyleElement),
      "id": string,
      "label": string,
      "defaultValue": string | object
    }]
  }],
  "interactions": [{
    "id": string,
    "supportedActions": array(enum(InteractionType))
  }],
  "features": {
   "enableComparisonDateRange": boolean
  }
}
Feldname Typ Beschreibung
data[] Array(object) Die Datenkonfiguration der Visualisierung. Diese Konfiguration wirkt sich auf den Bereich Daten des Eigenschaftenbereichs aus.
data[].id string Die ID des Datenbereichs. Der String darf nicht leer sein und darf keine Leerzeichen enthalten.
data[].label string Das Label für den Datenbereich.
data[].elements[] string Die zu rendernden Datenelemente.
data[].elements[].type string-Enum(DataElement) Der zu rendernde Datenelementtyp.
data[].elements[].id string Die ID des Datenelements. Der String darf nicht leer sein und darf keine Leerzeichen enthalten.
data[].elements[].label string Das Label der Kurzinfo für das Datenelement.
data[].elements[].options object(DataElementOptions) Die Datenoptionen für das Element. Dies ist abhängig vom Typ des Datenelements.
style[] Array(object) Die Stilkonfiguration, die für die Visualisierung erforderlich ist. Diese Konfiguration wirkt sich auf den Bereich Stil des Eigenschaftenbereichs aus. Jedes Objekt im Array stellt ein zu renderndes Stilelement dar. Die Reihenfolge der Elemente bestimmt die Reihenfolge, in der sie gerendert werden.
style[].id string Die ID des Stilabschnitts. Der String darf nicht leer sein und darf keine Leerzeichen enthalten.
style[].label string Das Label für den Bereich „Stil“.
style[].elements Array(object) Die zu rendernden Stilelemente.
style[].elements[].id string Die ID des Stilelements. Der String darf nicht leer sein und darf keine Leerzeichen enthalten.
style[].elements[].type string-Enum(StyleElement) Der Typ des Stilelements. Beispiel: Schriftartauswahl.
style[].elements[].label string Die Kurzinfo oder das Label für das Stilelement. Dies ist der Labeltext für ein Kästchenelement und der Text der Kurzinfo für andere Elementtypen.
style[].elements[].options Array(object) Die options für das Element. Dies gilt nur für die Stilelement-Typen SELECT_SINGLE und SELECT_RADIO.
style[].elements[].defaultValue string OR object Der Standardwert für das Stilelement. Ungültige Werte werden ignoriert.*
interactions[] Array(object) Die Interaktionskonfiguration der Visualisierung. Mit dieser Konfiguration wird festgelegt, ob sie als Filter verwendet werden kann oder nicht.
interactions[].id string Die ID des Interaktionselements. Der String darf nicht leer sein und darf keine Leerzeichen enthalten.
interactions[].supportedActions Array (Aufzählung(InteractionType) Die möglichen unterstützten Interaktionen
features object Die Funktionen, die Sie in Ihrer Visualisierung aktivieren oder deaktivieren möchten.
features.enableComparisonDateRange boolean Aktivieren Sie Vergleichszeiträume. Wenn kein Wert angegeben wird, wird standardmäßig false verwendet.

*defaultValue ist ein String für alles mit Ausnahme der Farbauswahl. Für Farben muss defaultValue ein Objekt mit folgendem Format sein:

{
    color: `string`
}

DataElement

Folgende Werte für Datenelemente sind möglich:

Enum-Wert Beschreibung
MESSWERT Rendert ein Messwertfeldelement.
DIMENSION Rendert ein Dimensionsfeldelement.
MAX_RESULTS Definiert die maximale Anzahl von Datenzeilen, die von dieser Visualisierung angefordert werden können

DataElement-Optionen

Folgende Werte für Datenelemente sind möglich:

Enum-Wert Optionstyp Verfügbare Optionen
MESSWERT Object max: number – die maximale Anzahl an Messwerten
Min.: Zahl – die Mindestanzahl der erforderlichen Messwerte
DIMENSION Object max: number – die maximale Anzahl der unterstützten Dimensionen.
Min.: Zahl – die Mindestanzahl der erforderlichen Dimensionen
supportedTypes: die Liste der unterstützten Typen. supportedTypes kann TIME, GEO oder DEFAULT enthalten
MAX_RESULTS Object max: number – die maximale Anzahl von Zeilen, die die Visualisierung anfordern kann Standardeinstellung: 2.500

StyleElement

Folgende Werte für Stilelemente sind möglich:

Enum-Wert Beschreibung Datentyp defaultValue (Konfiguration) Datentyp value (Nachricht) Standardwert
FONT_COLOR Rendert die Auswahl für die Schriftfarbe. Gültige Werte sind Hex-Farbcodes. STRING | OBJECT<Color> STRING | OBJECT<Color> Thematisch festgelegt
FONT_SIZE Rendert die Auswahl für die Schriftgröße. Gültige Werte sind folgende Pixel: 8, 9, 10, 11, 12, 14, 16, 18, 20, 24, 28, 30, 32, 36, 40, 44, 48, 60, 72, 84, 96. NUMBER NUMBER 12
FONT_FAMILY Rendert die Auswahl für die Schriftfamilie. Mit gültigen Werten für die folgenden Schriftarten und gültigen Werte für die folgenden Schriftarten sind folgende Schriftarten sind folgende Schriftarten sind bitte nur folgende Schriftarten gilt: Arial, Boogaloo, Bubblegum Sans, Chewy, Comic Sans MS, Coming Soon, Cormorant Unicase, Courier New, Droid, Droid Sans, Eater, Georgia, Google Sans, Google Sans, Google Sans, Google Sans, Google Sans, Great Vibes, STRING STRING Thematisch festgelegt
KÄSTCHEN Rendert ein Kästchen. BOOLEAN BOOLEAN false
TEXTINPUT Rendert ein Texteingabefeld. STRING STRING ""
TEXTAREA Rendert einen großen Texteingabebereich. STRING STRING ""
SELECT_SINGLE Rendert ein Drop-down-Menü mit vordefinierten Werten. STRING (für „defaultValue“, „options.label“ und „options.value“) STRING nicht definiert
SELECT_RADIO Rendert einen Optionsfelder mit vordefinierten Werten. STRING (für „defaultValue“, „options.label“ und „options.value“) STRING nicht definiert
FILL_COLOR Rendert eine Auswahl für die Füllfarbe. Gültige Werte sind Hex-Farbcodes. STRING | OBJECT<Color> OBJECT<Color> Thematisch festgelegt
BORDER_COLOR Rendert eine Rahmenfarbauswahl. Gültige Werte sind Hex-Farbcodes. STRING | OBJECT<Color> OBJECT<Color> Thematisch festgelegt
AXIS_COLOR Rendert eine Farbauswahl für die Achse. Gültige Werte sind Hex-Farbcodes. STRING | OBJECT<Color> OBJECT<Color> Thematisch festgelegt
GRID_COLOR Rendert eine Rasterfarbauswahl. Gültige Werte sind Hex-Farbcodes. STRING | OBJECT<Color> OBJECT<Color> Thematisch festgelegt
DURCHFÜHRUNG Rendert eine Deckkraftauswahl. Die Einheit ist %. Gültige Werte sind von 0 bis 1 in Schritten von 0,1 NUMBER NUMBER 1
LINE_WEIGHT Rendert eine Auswahl für die Linienstärke. Gültige Werte sind 0 bis 5. Bei „0“ wird im Drop-down-Menü „Keine“ angezeigt. NUMBER NUMBER
LINE_STYLE Rendert eine Linienartauswahl. Zulässige Standardwerte: solid, dashed, dotted, double. STRING STRING "solid"
BORDER_RADIUS Rendert eine Rahmenradiusauswahl. Gültige Werte sind: 0, 1, 2, 3, 4, 5, 10, 15, 20, 25, 30, 40, 50, 60, 70, 80, 90, 100 NUMBER NUMBER Thematisch festgelegt
INTERVAL Rendert einen Intervallselektor. Werte sind Ganzzahlen. NUMBER NUMBER 0

Mit Stilelementen werden die Symbole konfiguriert, die auf dem Tab „Style“ der Property angezeigt werden Steuerfeld.

Stilelementoptionen

Unterstützte Optionen für Stilelemente

options: array(options)
Enum-Wert Optionsobjekt
SELECT_SINGLE 
        {
            label: `string`,
            value: `string`
        }
SELECT_RADIO 
        {
            label: `string`,
            value: `string`
        }
INTERVAL 
        {
            max: `number`,
            min: `number`
        }

Datentypen

Objekt<Farbe>

{
  color: STRING<Color>,
  opacity: NUMBER<Opacity>
}

STRING&lt;Color&gt;

Stringwert, der einen Hex-Farbcode enthält.

Beispiel

"color": "#0000ff"

NUMBER<Deckkraft>

Zahlenwert von 0 bis 1 in Schritten von 0,10

Beispiel

"opacity": 0.2

InteractionType

Mit InteractionTypes werden die Interaktionsoptionen konfiguriert, die im Stil Data verfügbar sind des Eigenschaftenbereichs. Derzeit wird nur "FILTER" unterstützt.

Enum-Wert Beschreibung
"FILTER" Ermöglicht es Benutzern, Visualisierungen als Filter zu verwenden.

Beispielkonfiguration

{
  "data": [{
    "id": "concepts",
    "label": "concepts",
    "elements": [
      {
        "id": "dimension1",
        "label": "first dimension",
        "type": "DIMENSION",
        "options": {
          "min": 1,
          "max": 3,
          "supportedTypes": ["DEFAULT"]
        }
      },
      {
        "id": "metric",
        "label": "metric",
        "type": "METRIC",
        "options": {
          "min": 1,
          "max": 3
        }
      }
    ]
  }],
  "style": [
    {
      "id": "colors",
      "label": "Highlight Colors",
      "elements": [
        {
          "id": "accentColor",
          "label": "Accent Color",
          "type": "SELECT_SINGLE",
          "defaultValue": "rain",
          "options": [
            {
              "label": "Summer",
              "value": "summer"
            },
            {
              "label": "Fall",
              "value": "fall"
            }
          ]
        },
        {
          "id": "reverseColor",
          "label": "Show reverse color",
          "defaultValue": false,
          "type": "CHECKBOX"
        },
        {
          "id": "fillColor",
          "label": "Fill Color",
          "defaultValue": {
            "color": "#0000ff"
          },
          "type": "FILL_COLOR"
        },
        {
          "id": "textOpacity",
          "label": "Text Opacity",
          "defaultValue": 0.2,
          "type": "OPACITY"
        },
        {
          "id": "customText",
          "label": "Custom Text",
          "defaultValue": "0.2",
          "type": "TEXTINPUT"
        }
      ]
    },
    {
      "id": "text",
      "label": "Highlight Text",
      "elements": [
        {
          "id": "textFontSize",
          "label": "Font size",
          "defaultValue": 10,
          "type": "FONT_SIZE"
        },
        {
          "id": "font",
          "label": "Font family",
          "defaultValue": "Arial",
          "type": "FONT_FAMILY"
        }
      ]
    }
  ],
  "interactions": [
    {
      "id": "interactionsConfigId",
      "supportedActions": ["FILTER"]
    }
  ],
  "features": {
    "enableComparisonDateRange": false
  }
}