En esta página, se describe cómo crear un tipo de visualización personalizada que se pueda agregar a Looker Marketplace y al que otros usuarios de Looker puedan acceder. También puedes crear una visualización personalizada directamente en tu proyecto sin ponerla a disposición de otros clientes de Looker.
Ten en cuenta que debes ser miembro de la red de socios de Looker o 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 Looker Marketplace, que incluyen tipos de visualización para agregar a la biblioteca de visualización nativa de Looker.
Para desarrollar una visualización personalizada y ponerla a disposición de todos los clientes de Looker a través de Looker Marketplace, sigue estos pasos:
- Desarrolla una visualización.
- Crea un proyecto de Looker para la visualización.
- Envía el proyecto de Looker a un repositorio de Git.
- Prueba la funcionalidad de la visualización.
- Envía tu visualización a Looker.
Desarrollo de un tipo de visualización
Identifica un tipo de visualización que te gustaría desarrollar. Confirma que esta visualización no aparezca en Marketplace ni como 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.
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 de LICENSE: enumera la licencia o las licencias con las que se distribuye la visualización; utiliza el texto:
This Looker visualization is distributed with the following license:...
Archivo
README.md
: Proporciona una descripción de tu 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 en el proyecto, lo que permite un correcto control de versiones y administración de paquetes.Archivo de manifiesto (
manifest.lkml
): Especifica unid
(un identificador único) y unlabel
(que 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 indica cómo aparecerá la visualización en Marketplace, la ubicación deimage_uri
, un eslogan que describe el caso de uso de la visualización y también 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"
}
}
}
Envía el proyecto a Git
Aloja tu 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:
- Crea un repositorio de GitHub de acceso público.
- Establece la URL del repositorio de tu proyecto de Looker en la URL del repositorio de GitHub.
- Sigue las instrucciones de Git en Looker para validar, confirmar e implementar tu código en producción.
Probar la funcionalidad de la visualización
Prueba la nueva visualización aplicándola a una exploración o vista adecuada en tu instancia de Looker:
- Navega a la vista o Explorar.
- Si estás en una vista, haz clic en Edit para editarla.
- Haga clic en el menú de tres puntos en el menú del tipo de visualización para abrir la lista desplegable de visualizaciones.
- Seleccione su visualización personalizada.
- Haz clic en Guardar para guardar el cambio en la vista. Toma nota de los paneles que podrían verse afectados por este cambio.
Looker requiere las siguientes funciones en las visualizaciones disponibles en Looker Marketplace:
Función | Requeridos |
---|---|
Compatibilidad para desglosar la visualización | Sí |
Capacidad de heredar las paletas de colores de Looker | Sí |
Capacidad de respuesta al tamaño de la pantalla y del navegador | Sí |
Familia de fuentes coherente: font-family : Helvetica , Arial , sans-serif |
Sí |
Tamaño de la fuente | Sí |
Puede activar o desactivar Etiquetas de valor y Etiquetas de ejes en el panel de configuración de visualización. | Sí |
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 |
Sí |
Mensajes de error claros (por ejemplo, Esta visualización requiere 1 dimensión y 2 mediciones) |
Sí |
Todas las opciones del panel de configuración de visualización hacen un cambio aparente en la visualización. | Sí |
Uso del formato value del campo de forma predeterminada |
Sí (si corresponde) |
Se produce un error cuando una consulta no muestra resultados | Sí |
Cómo enviar la visualización para su revisión
Una vez que tu visualización esté lista para enviarse, sigue las instrucciones que se indican en Envía contenido a Looker Marketplace a fin de crear documentación de respaldo para tu visualización, envíala al equipo de Looker para su revisión y publícala en Looker Marketplace.