Desarrollo de una visualización personalizada para Looker Marketplace

En esta página, se describe cómo crear un tipo de visualización personalizado que se puede agregar al Marketplace de Looker y al que pueden acceder otros usuarios de Looker. También puedes crear una visualización personalizada directamente en tu proyecto sin que esté disponible para otros clientes de Looker.

Ten en cuenta que debes ser miembro de la red de socios de Looker o de un cliente de Looker para enviar contenido a Looker Marketplace.

Looker Marketplace es una ubicación central para encontrar, implementar y administrar muchos tipos de contenido de Looker, como Looker BlocksTM, aplicaciones, visualizaciones y otros complementos.

Con la función Marketplace de Looker habilitada, los clientes de Looker pueden instalar complementos de Marketplace de Looker, que incluyen tipos de visualización para agregar a la biblioteca de visualización nativa de Looker.

A fin de desarrollar una visualización personalizada que esté disponible para todos los clientes de Looker a través de Looker Marketplace, sigue estos pasos:

  1. Desarrolla una visualización.
  2. Crea un proyecto de Looker para la visualización.
  3. Envía el proyecto de Looker a un repositorio de Git.
  4. Prueba la funcionalidad de la visualización.
  5. Envía la visualización a Looker.

Cómo desarrollar un tipo de visualización

Identifique un tipo de visualización que le gustaría desarrollar. (Confirma que esta visualización aún no aparezca en Marketplace o como una visualización nativa de Looker).

Desarrolla tu visualización personalizada en JavaScript mediante la API de visualización de Looker con tu entorno de JavaScript.

Cómo crear un proyecto de Looker para la visualización

Crea un proyecto de Looker para representar tu visualización personalizada. El proyecto debe contener los siguientes archivos:

  • Archivo LICENSE: Muestra las licencias con las que se distribuye la visualización, con el texto
    "Esta visualización de Looker se distribuye con la siguiente licencia:...".

  • README.md: Proporciona una descripción de la visualización, cómo funciona y cualquier información adicional.

  • Archivo JavaScript (.js): Contiene una versión condensada del código JavaScript que usaste para producir tu visualización. Con Marketplace, los archivos JS se incluyen dentro del proyecto, lo que permite un control de versiones adecuado y la administración de paquetes.

  • Archivo de manifiesto (manifest.lkml): Especifica un id (un identificador único) y un label (se muestra en la IU de Looker para esta visualización). Por ejemplo:

    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: []
    }
  • Archivo de ficha (marketplace.json): Configura la ficha de Marketplace para la visualización personalizada y, además, incluye una etiqueta que mostrará cómo aparecerá en Marketplace, la ubicación de image_uri, un eslogan que describe el caso de uso de la visualización y, además, define las constantes de campo de Marketplace que los usuarios ingresan durante la instalación. Por ejemplo:
{
  "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"
        }
    }
}

Cómo enviar el proyecto a Git

Alojar su LookML de visualización en un repositorio de GitHub de acceso público Si creaste la visualización en un proyecto de Looker, sigue estos pasos para enviarla a un repositorio nuevo:

  1. Crea un repositorio de GitHub de acceso público.
  2. Configura la URL del repositorio de tu proyecto de Looker en la URL de tu repositorio de GitHub.
  3. Sigue las indicaciones de Git en Looker para validar, confirmar y, luego, implementar tu código en producción.

Prueba la funcionalidad de la visualización

Para probar la nueva visualización, aplícala a una instancia apropiada de Explorar o Mirar en tu instancia de Looker:

  1. Navega a Mirar o Explorar.
  2. Si estás en un estilo, haz clic en Editar para editarlo.
  3. Haga clic en el menú de tres puntos en el menú de tipo de visualización para abrir la lista desplegable de visualizaciones.
  4. Seleccione su visualización personalizada.
  5. Haz clic en Guardar para guardar el cambio en Look. Observa los paneles que pueden verse afectados por este cambio.

Looker requiere las siguientes funciones en las visualizaciones disponibles en Looker Marketplace:

Función Requeridos
Compatibilidad con el desglose de la visualización
Capacidad de heredar las paletas de colores de Looker
Capacidad de respuesta al navegador y al tamaño de la pantalla
Familia de fuentes coherente: font-family: Helvetica, Arial, sans-serif
Tamaño de fuente
La capacidad de activar o desactivar las Etiquetas de valor y las Etiquetas de eje en el panel de configuración de visualización
Visualización de datos dinámicos Sí (si corresponde)
Actualizaciones de visualización basadas en la interactividad del usuario con la función updateAsync o is update function
Borrar mensajes de error (por ejemplo, Esta visualización requiere 1 dimensión y 2 medidas)
Todas las opciones en el panel de configuración de visualización hacen un cambio aparente en la visualización.
Uso del formato value del campo de forma predeterminada Sí (si corresponde)
Se produce un error cuando una consulta no muestra resultados

Cómo enviar la visualización para su revisión

Una vez que tu visualización esté lista para su envío, sigue las instrucciones que se indican en Cómo enviar contenido a Looker Marketplace a fin de crear documentación de respaldo para la visualización, enviarla al equipo de Looker para su revisión y publicarla en Looker Marketplace.