Mengembangkan visualisasi kustom untuk Looker Marketplace

Halaman ini menjelaskan cara membuat jenis visualisasi kustom yang dapat ditambahkan ke Looker Marketplace dan diakses oleh pengguna Looker lainnya. Anda juga dapat membuat visualisasi kustom langsung di project tanpa menyediakannya untuk pelanggan Looker lainnya.

Perhatikan bahwa Anda harus menjadi anggota Jaringan Partner Looker atau pelanggan Looker untuk mengirimkan konten ke Looker Marketplace.

Looker Marketplace adalah lokasi pusat untuk menemukan, men-deploy, dan mengelola berbagai jenis konten Looker, seperti Looker Blocks™, aplikasi, visualisasi, dan plugin lainnya.

Dengan mengaktifkan fitur Marketplace Looker, pelanggan Looker dapat menginstal plugin Looker Marketplace, yang mencakup jenis visualisasi untuk ditambahkan ke library visualisasi native Looker.

Untuk mengembangkan visualisasi kustom dan menyediakannya kepada semua pelanggan Looker melalui Looker Marketplace, ikuti langkah-langkah berikut:

  1. Kembangkan visualisasi.
  2. Buat project Looker untuk visualisasi.
  3. Kirim project Looker ke repositori Git.
  4. Uji fungsi visualisasi.
  5. Kirim visualisasi Anda ke Looker.

Mengembangkan jenis visualisasi

Identifikasi jenis visualisasi yang ingin Anda kembangkan. (Pastikan visualisasi ini belum tercantum di Marketplace atau sebagai visualisasi Looker native.)

Kembangkan visualisasi kustom Anda di JavaScript menggunakan Looker Visualization API dengan lingkungan JavaScript Anda.

Membuat project Looker untuk visualisasi

Buat project Looker untuk merepresentasikan visualisasi kustom Anda. Project harus berisi file berikut:

  • File LICENSE: Mencantumkan lisensi yang digunakan untuk mendistribusikan visualisasi, menggunakan teks:

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

  • File README.md: Memberikan deskripsi visualisasi Anda, cara kerjanya, dan informasi tambahan apa pun.

  • File JavaScript (.js): Berisi versi ringkas kode JavaScript yang Anda gunakan untuk membuat visualisasi. Dengan Marketplace, file JS disertakan dalam project, yang memungkinkan pembuatan versi dan pengelolaan paket yang tepat.

  • File manifes (manifest.lkml): Menentukan id (ID unik) dan label (ditampilkan di UI Looker untuk visualisasi ini). Contoh:

    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 listingan (marketplace.json): Mengonfigurasi listingan Marketplace untuk visualisasi kustom dan menyertakan label untuk tampilan visualisasi di Marketplace, lokasi image_uri, tagline yang menjelaskan kasus penggunaan untuk visualisasi, dan juga menentukan konstanta kolom Marketplace yang dimasukkan pengguna selama penginstalan. Contoh:
{
  "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"
        }
    }
}

Mengirim project ke Git

Hosting LookML visualisasi Anda di repositori GitHub yang dapat diakses secara publik. Dengan asumsi bahwa Anda membuat visualisasi di project Looker, ikuti langkah-langkah berikut untuk mendorongnya ke repositori baru:

  1. Buat repositori GitHub yang dapat diakses secara publik.
  2. Tetapkan URL Repositori project Looker Anda ke URL repositori GitHub Anda.
  3. Ikuti perintah Git di Looker untuk memvalidasi, melakukan commit, dan men-deploy kode ke produksi.

Menguji fungsi visualisasi

Uji visualisasi baru dengan menerapkannya ke Jelajahi atau Tampilan yang sesuai di instance Looker Anda:

  1. Buka Look atau Explore.
  2. Jika berada di Tampilan, klik Edit untuk mengedit Tampilan.
  3. Klik menu tiga titik di menu jenis visualisasi untuk membuka daftar drop-down visualisasi.
  4. Pilih visualisasi kustom Anda.
  5. Klik Simpan untuk menyimpan perubahan pada Tampilan. Perhatikan dasbor yang mungkin terpengaruh oleh perubahan ini.

Looker memerlukan fungsi ini dalam visualisasi yang tersedia dari Looker Marketplace:

Fungsi Wajib
Dukungan untuk penelusuran visualisasi Ya
Kemampuan untuk mewarisi palet warna Looker Ya
Respons terhadap browser dan ukuran layar Ya
Jenis font yang konsisten: font-family: Helvetica, Arial, sans-serif Ya
Ukuran font Ya
Kemampuan untuk mengalihkan Label Nilai dan Label Sumbu di panel konfigurasi visualisasi Ya
Visualisasi data yang diputar Ya (jika berlaku)
Update visualisasi berdasarkan interaktivitas pengguna menggunakan fungsi updateAsync atau is update function Ya
Pesan error yang jelas (misalnya, Visualisasi ini memerlukan 1 dimensi dan 2 ukuran) Ya
Semua opsi di panel konfigurasi visualisasi akan membuat perubahan yang jelas pada visualisasi Ya
Penggunaan pemformatan value kolom secara default Ya (jika berlaku)
Error ditampilkan saat kueri tidak menampilkan hasil Ya

Mengirimkan visualisasi untuk ditinjau

Setelah visualisasi Anda siap dikirim, ikuti petunjuk di Mengirimkan konten ke Looker Marketplace untuk membuat dokumentasi pendukung visualisasi Anda, mengirimkan visualisasi Anda ke tim Looker untuk ditinjau, dan memublikasikan visualisasi Anda ke Looker Marketplace.