Sviluppo di una visualizzazione personalizzata per il marketplace di Looker

Questa pagina descrive come creare un tipo di visualizzazione personalizzata che può essere aggiunto a Looker Marketplace e a cui possono accedere altri utenti di Looker. Puoi anche creare una visualizzazione personalizzata direttamente nel tuo progetto senza renderla disponibile per altri clienti di Looker.

Tieni presente che per inviare contenuti al marketplace di Looker devi essere membro della rete di partner di Looker o un cliente di Looker.

Looker Marketplace è una piattaforma centralizzata per trovare, eseguire il deployment e gestire molti tipi di contenuti di Looker, come Looker Blocks™, applicazioni, visualizzazioni e altri plug-in.

Con la funzionalità Marketplace di Looker abilitata, i clienti di Looker possono installare i plug-in di Looker Marketplace, che includono tipi di visualizzazione da aggiungere alla libreria di visualizzazioni native di Looker.

Per sviluppare una visualizzazione personalizzata e renderla disponibile per tutti i clienti di Looker tramite Looker Marketplace:

  1. Sviluppa una visualizzazione.
  2. Crea un progetto Looker per la visualizzazione.
  3. Esegui il push del progetto Looker in un repository Git.
  4. Testa la funzionalità della visualizzazione.
  5. Invia la visualizzazione a Looker.

Sviluppo di un tipo di visualizzazione

Identifica un tipo di visualizzazione che vuoi sviluppare. Verifica che questa visualizzazione non sia già elencata nel Marketplace o come visualizzazione nativa di Looker.

Sviluppare la visualizzazione personalizzata in JavaScript utilizzando l'API Looker Visualization con il tuo ambiente JavaScript.

Creare un progetto Looker per la visualizzazione

Crea un progetto Looker per rappresentare la visualizzazione personalizzata. Il progetto deve contenere i seguenti file:

  • File LICENSE: elenca la licenza o le licenze con cui viene distribuita la visualizzazione utilizzando il testo:

    This Looker visualization is distributed with the following license:...

  • File README.md: fornisce una descrizione della visualizzazione, il suo funzionamento ed eventuali informazioni aggiuntive.

  • File JavaScript (.js): contiene una versione condensata del codice JavaScript utilizzato per produrre la visualizzazione. Con Marketplace, i file JS sono inclusi nel progetto, il che consente una gestione corretta delle versioni e dei pacchetti.

  • File manifest (manifest.lkml): specifica un id (un identificatore univoco) e un label (visualizzato nell'interfaccia utente di Looker per questa visualizzazione). Ad esempio:

    constant: vis_id {
        value: "default_id"
        export: override_optional
    }
    constant: vis_label {
        value: "default_label"
        export: override_optional
    }
    visualization: {
        id: "@{vis_id}"
        label: "@{vis_label}"
        file: "my_local.js"
        sri_hash: "my_sri_hash"
        dependencies: []
    }
  • File della scheda (marketplace.json): configura la scheda del marketplace per la visualizzazione personalizzata e include un'etichetta per la visualizzazione nel marketplace, la posizione del image_uri, un tagline che descrive il caso d'uso della visualizzazione e definisce anche le costanti di campo del marketplace inserite dagli utenti durante l'installazione. Ad esempio:
{
  "label": "Gauge Visualization",
  "category_label": "plug-ins",
  "branding": {
    "image_uri": "https://marketplace-api.looker.com/visualization-screenshots/gauge_icon.png",
    "tagline": "Use the Gauge visualization to display a measure and progress to a goal."
  },
   "constants": {
        "vis_label": {
            "label": "Visualization Label",
            "description": "This label will appear in the visualization selector in the Looker Explore UI."
        },
        "vis_id": {
            "label": "Visualization Id",
            "description": "This must be a unique ID across all visualizations.",
            "value_constraint": "visualization"
        }
    }
}

Eseguire il push del progetto su Git

Ospitata il codice LookML della visualizzazione in un repository GitHub accessibile pubblicamente. Supponendo che tu abbia creato la visualizzazione in un progetto Looker, segui questi passaggi per eseguirne il push in un nuovo repository:

  1. Crea un repository GitHub accessibile pubblicamente.
  2. Imposta l'URL del repository del progetto Looker sull'URL del tuo repository GitHub.
  3. Segui le istruzioni di Git in Looker per convalidare, eseguire commit e implementare il codice in produzione.

Testare la funzionalità della visualizzazione

Testa la nuova visualizzazione applicandola a un'esplorazione o a un look appropriato nella tua istanza Looker:

  1. Vai al Look o all'esplorazione.
  2. Se sei in un look, fai clic su Modifica per modificarlo.
  3. Fai clic sul menu con tre puntini nel menu del tipo di visualizzazione per aprire l'elenco a discesa delle visualizzazioni.
  4. Seleziona la visualizzazione personalizzata.
  5. Fai clic su Salva per salvare la modifica al look. Prendi nota delle dashboard che potrebbero essere interessate da questa modifica.

Looker richiede queste funzioni nelle visualizzazioni disponibili su Looker Marketplace:

Funzione Obbligatorio
Supporto per il drill-down nella visualizzazione Sì
Possibilità di ereditare le tavolozze dei colori di Looker Sì
Adattabilità alle dimensioni del browser e dello schermo Sì
Famiglia di caratteri coerente: font-family: Helvetica, Arial, sans-serif Sì
Dimensionamento dei caratteri Sì
Possibilità di attivare/disattivare Etichette dei valori ed Etichette asse nel riquadro di configurazione della visualizzazione Sì
Visualizzazione dei dati pivotati Sì (se applicabile)
Aggiornamenti della visualizzazione in base all'interattività dell'utente utilizzando la funzione updateAsync o is update function Sì
Messaggi di errore chiari (ad es. Questa visualizzazione richiede una dimensione e due misure) Sì
Tutte le opzioni nel riquadro di configurazione della visualizzazione apportano una modifica apparente alla visualizzazione Sì
Utilizzo della formattazione value del campo per impostazione predefinita Sì (se applicabile)
Viene generato un errore quando una query non restituisce risultati Sì

Invio della visualizzazione per la revisione

Una volta che la visualizzazione è pronta per essere inviata, segui le istruzioni riportate in Invio di contenuti su Looker Marketplace per creare la documentazione di supporto per la visualizzazione, inviarla al team di Looker per la revisione e pubblicarla su Looker Marketplace.