Riferimento alla configurazione della visualizzazione della community

La configurazione di visualizzazione definisce i dati e gli attributi di stile richiesti da un visualizzazione.

La configurazione è prevista come file JSON con la seguente struttura:

{
  "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
  }
}
Nome campo Tipo Descrizione
data[] Array(object) La configurazione dei dati della visualizzazione. Questa configurazione influisce sul riquadro Dati del riquadro delle proprietà.
data[].id string L'ID della sezione dei dati. Deve essere una stringa non vuota e senza spazi.
data[].label string L'etichetta per la sezione dei dati.
data[].elements[] string Gli elementi dei dati da visualizzare.
data[].elements[].type Enum string(DataElement) Il tipo di elemento dati da visualizzare.
data[].elements[].id string L'ID dell'elemento dei dati. Deve essere una stringa non vuota e senza spazi.
data[].elements[].label string L'etichetta della descrizione comando per l'elemento dati.
data[].elements[].options object(DataElementOptions) Le opzioni relative ai dati dell'elemento. Dipende dal tipo di elemento dati.
style[] Array(object) La configurazione dello stile richiesta dalla visualizzazione. Questa configurazione influisce sul riquadro Stile del riquadro delle proprietà. Ogni oggetto nell'array rappresenta un elemento di stile da visualizzare. L'ordine degli elementi determina l'ordine in cui verranno visualizzati.
style[].id string L'ID della sezione di stile. Deve essere una stringa non vuota e senza spazi.
style[].label string L'etichetta per la sezione Stile.
style[].elements Array(object) Gli elementi di stile da visualizzare.
style[].elements[].id string L'ID dell'elemento di stile. Deve essere una stringa non vuota e priva di spazi.
style[].elements[].type Enum string(StyleElement) Il tipo di elemento di stile. Ad es. selettore di carattere.
style[].elements[].label string La descrizione comando o l'etichetta per l'elemento di stile. Testo dell'etichetta per un elemento casella di controllo e testo della descrizione comando per altri tipi di elementi.
style[].elements[].options Array(object) options per l'elemento. Questo valore è valido solo per i tipi di elemento stile SELECT_SINGLE e SELECT_RADIO.
style[].elements[].defaultValue string OR object Il valore predefinito per l'elemento di stile. I valori non validi verranno ignorati.*
interactions[] Array(object) La configurazione delle interazioni della visualizzazione. Questa configurazione determina se può fungere o meno da filtro.
interactions[].id string L'ID dell'elemento di interazione. Deve essere una stringa non vuota e senza spazi.
interactions[].supportedActions Array (enum(InteractionType) Le possibili interazioni supportate
features object Le funzionalità da attivare o disattivare nella visualizzazione.
features.enableComparisonDateRange boolean Attiva gli intervalli di date di confronto. Se non specificato, il valore predefinito è false.

*defaultValue è una stringa per tutto tranne i selettori del colore. Per colori, defaultValue deve essere un oggetto del formato:

{
    color: `string`
}

DataElement

I valori per gli elementi dei dati possono essere uno dei seguenti:

Valore enum Descrizione
METRICA Visualizza un elemento del campo metrica.
DIMENSION Visualizza un elemento del campo di dimensione.
MAX_RESULTS Definisce il numero massimo di righe di dati che possono essere richieste da questa visualizzazione

Opzioni DataElement

I valori per gli elementi dei dati possono essere uno dei seguenti:

Valore enum Tipo di opzione Opzioni disponibili
METRICA Oggetto max: numero - il numero massimo di metriche
min: numero - il numero minimo di metriche richieste
DIMENSION Oggetto max: number - Il numero massimo di dimensioni supportate.
min: numero - il numero minimo di dimensioni richieste
supportedType: l'elenco dei tipi supportati. supportedTypes può includere TIME, GEO o DEFAULT
MAX_RESULTS Oggetto max: numero - Il numero massimo di righe che la visualizzazione può richiedere. Valore predefinito: 2500

StyleElement

I valori per gli elementi di stile possono essere uno dei seguenti:

Valore enum Descrizione Tipo di dati defaultValue (configurazione) value tipo di dati (messaggio) Valore predefinito
FONT_COLOR Visualizza il selettore del colore del carattere. I valori validi sono i codici colore esadecimali. STRING | OBJECT<Color> STRING | OBJECT<Color> Determinato dal tema.
FONT_SIZE Visualizza il selettore della dimensione del carattere. I valori validi sono i seguenti 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 Visualizza il selettore della famiglia di caratteri. o i seguenti caratteri o i seguenti caratteri o caratteri validi sono i caratteri o i seguenti caratteri o i seguenti caratteri: Google e i seguenti caratteri o i seguenti caratteri o valori validi sono i caratteri o i seguenti caratteri o i seguenti caratteri o caratteri validi: questa o la seguente o i seguenti caratteri o i seguenti caratteri o i seguenti caratteri o caratteri validi sono i caratteri o i seguenti caratteri o i seguenti caratteri o valori validi: questa o ver o i seguenti caratteri o i seguenti caratteri o caratteri validi sono i caratteri o i seguenti caratteri o caratteri e sono i seguenti o i seguenti caratteri o i seguenti caratteri o i seguenti caratteri o caratteri e sono i seguenti o i seguenti caratteri o i seguenti caratteri o caratteri e i seguenti caratteri o caratteri validi: questa o ver o i seguenti caratteri o i seguenti caratteri o valori validi sono i seguenti o i seguenti caratteri o caratteri e i seguenti caratteri o caratteri validi sono i seguenti o i seguenti caratteri o i seguenti caratteri o caratteri e i seguenti caratteri: STRING STRING Determinato dal tema.
CHECKBOX Visualizza una casella di controllo. BOOLEAN BOOLEAN false
TEXTINPUT Visualizza una casella di immissione di testo. STRING STRING ""
TEXTAREA Visualizza un'area di input di testo di grandi dimensioni. STRING STRING ""
SELECT_SINGLE Visualizza un menu a discesa con valori predefiniti. STRING (per defaultValue, options.label e options.value) STRING non definito
SELECT_RADIO Visualizza un selettore di opzione con valori predefiniti. STRING (per defaultValue, options.label e options.value) STRING non definito
FILL_COLOR Visualizza un selettore del colore di riempimento. I valori validi sono i codici colore esadecimali. STRING | OBJECT<Color> OBJECT<Color> Determinato dal tema.
BORDER_COLOR Visualizza un selettore del colore del bordo. I valori validi sono i codici colore esadecimali. STRING | OBJECT<Color> OBJECT<Color> Determinato dal tema.
AXIS_COLOR Visualizza un selettore del colore dell'asse. I valori validi sono i codici colore esadecimali. STRING | OBJECT<Color> OBJECT<Color> Determinato dal tema.
GRID_COLOR Visualizza un selettore di colore della griglia. I valori validi sono i codici colore esadecimali. STRING | OBJECT<Color> OBJECT<Color> Determinato dal tema.
Opacità Visualizza un selettore di opacità. L'unità è %. I valori validi sono compresi tra 0 e 1 con incrementi di 0,1 NUMBER NUMBER 1
LINE_WEIGHT Visualizza un selettore di spessore linea. I valori validi sono compresi tra 0 e 5. 0 verrà visualizzato come Nessuno nel menu a discesa. NUMBER NUMBER
LINE_STYLE Visualizza un selettore di stile linea. Valori predefiniti accettabili: solid, dashed, dotted, double. STRING STRING "solid"
BORDER_RADIUS Visualizza un selettore del raggio del bordo. I valori validi sono: 0, 1, 2, 3, 4, 5, 10, 15, 20, 25, 30, 40, 50, 60, 70, 80, 90, 100 NUMBER NUMBER Determinato dal tema.
INTERVALLO Visualizza un selettore di intervallo. I valori sono numeri interi. NUMBER NUMBER 0

Gli elementi di stile configurano le icone visualizzate nella scheda Style della proprietà Riquadro.

Opzioni degli elementi di stile

Alcuni elementi di stile supportano opzioni

options: array(options)
Valore enum Oggetto opzioni
SELECT_SINGLE 
        {
            label: `string`,
            value: `string`
        }
SELECT_RADIO 
        {
            label: `string`,
            value: `string`
        }
INTERVALLO 
        {
            max: `number`,
            min: `number`
        }

Tipi di dati

Oggetto<Color>

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

STRING&lt;Color&gt;

Un valore di stringa contenente un codice colore esadecimale.

Esempio

"color": "#0000ff"

NUMBER<Opacità>

Un valore numerico compreso tra 0 e 1 con incrementi di 0,10

Esempio

"opacity": 0.2

InteractionType

InteractionTypes configura le opzioni di interazione disponibili nello stile Data del riquadro delle proprietà. Al momento è supportato solo il criterio "FILTER".

Valore enum Descrizione
"FILTER" Consente agli utenti di utilizzare la visualizzazione come filtro.

Configurazione di esempio

{
  "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
  }
}