Questa pagina descrive come creare un tipo di visualizzazione personalizzata che possa essere aggiunto a Looker Marketplace e accessibile da altri utenti di Looker. Puoi anche creare una visualizzazione personalizzata direttamente nel progetto senza renderla disponibile ad altri clienti di Looker.
Tieni presente che devi essere un membro della rete di partner di Looker o un cliente di Looker per inviare contenuti a Looker Marketplace.
Looker Marketplace è una posizione centralizzata per trovare, eseguire il deployment e gestire molti tipi di contenuti Looker, come Looker BlocksTM, applicazioni, visualizzazioni e altri plug-in.
Con la funzionalità Marketplace di Looker abilitata, i clienti di Looker possono installare plug-in di Looker Marketplace, che includono tipi di visualizzazione da aggiungere alla libreria di visualizzazioni nativa di Looker.
Per sviluppare una visualizzazione personalizzata e renderla disponibile a tutti i clienti Looker tramite Looker Marketplace, segui questi passaggi:
- Sviluppa una visualizzazione.
- Crea un progetto Looker per la visualizzazione.
- Esegui il push del progetto Looker in un repository Git.
- Verifica la funzionalità della visualizzazione.
- Invia la visualizzazione a Looker.
Sviluppare 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 Looker nativa.
Sviluppa la tua visualizzazione personalizzata in JavaScript utilizzando l'API di visualizzazione Looker con il tuo ambiente JavaScript.
Creazione di un progetto Looker per la visualizzazione in corso...
Crea un progetto Looker per rappresentare la tua visualizzazione personalizzata. Il progetto deve contenere i seguenti file:
File LICENSE: elenca le licenze 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 modo in cui funziona ed eventuali informazioni aggiuntive.File JavaScript (
.js
): contiene una versione ridotta del codice JavaScript che hai utilizzato per produrre la visualizzazione. Con Marketplace, i file JS sono inclusi nel progetto, il che consente un corretto controllo delle versioni e una gestione dei pacchetti.File manifest (
manifest.lkml
): specifica unid
(un identificatore univoco) e unlabel
(mostrati nella UI 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 scheda (
marketplace.json
): configura la scheda del Marketplace per la visualizzazione personalizzata e include un'etichetta che specifica come apparirà la visualizzazione nel Marketplace, la posizione delimage_uri
, uno slogan che descrive il caso d'uso della visualizzazione e definisce anche le costanti dei campi 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"
}
}
}
Push del progetto a Git
Ospita il tuo LookML di visualizzazione su 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:
- Crea un repository GitHub accessibile pubblicamente.
- Imposta l'URL del repository del progetto Looker sull'URL del repository GitHub.
- Segui le istruzioni di Git in Looker per convalidare, eseguire il commit e il deployment del codice in produzione.
Testare la funzionalità della visualizzazione
Testa la nuova visualizzazione applicandola a un'esplorazione o un Look appropriato sulla tua istanza Looker:
- Vai al Look o all'esplorazione.
- Se stai eseguendo un Look, fai clic su Modifica per modificarlo.
- Fai clic sul menu con tre puntini nel menu del tipo di visualizzazione per aprire l'elenco a discesa delle visualizzazioni.
- Seleziona la visualizzazione personalizzata.
- Fai clic su Salva per salvare la modifica al Look. Prendi nota delle eventuali dashboard che potrebbero essere interessate da questa modifica.
Looker richiede queste funzioni nelle visualizzazioni disponibili da Looker Marketplace:
Funzione | Obbligatorio |
---|---|
Supporto per il drill-down della visualizzazione | Sì |
Possibilità di ereditare le tavolozze dei colori di Looker | Sì |
Reattività al browser e alle dimensioni dello schermo | Sì |
Famiglia di caratteri coerente: font-family : Helvetica , Arial , sans-serif |
Sì |
Dimensioni dei caratteri | Sì |
Possibilità di attivare/disattivare Etichette valori ed Etichette asse nel riquadro di configurazione della visualizzazione | Sì |
Visualizzazione dei dati sottoposti a pivot | Sì (se applicabile) |
Aggiornamenti della visualizzazione in base all'interattività degli utenti con la funzione updateAsync o is update |
Sì |
Messaggi di errore chiari (ad esempio, Questa visualizzazione richiede una dimensione e due misure). |
Sì |
Tutte le opzioni nel riquadro di configurazione della visualizzazione fanno un'evidente modifica alla visualizzazione | Sì |
Utilizzo della formattazione value del campo per impostazione predefinita |
Sì (se applicabile) |
Viene visualizzato un errore quando una query non restituisce risultati | Sì |
Invio della visualizzazione per la revisione
Quando la visualizzazione è pronta per essere inviata, segui le istruzioni riportate in Inviare contenuti a Looker Marketplace per creare una documentazione di supporto per la visualizzazione, inviala al team di Looker per la revisione e pubblicala su Looker Marketplace.