Eventos de JavaScript incorporados

Después de crear una incorporación (esto se puede hacer públicamente, de forma privada, con el inicio de sesión único [SSO] o mediante la API), puedes interactuar con esos iframes a través de JavaScript. Puedes hacer que tu página sea más dinámica, según el estado del elemento incorporado, o incluso hacer cambios en el elemento incorporado desde tu página web.

Ten en cuenta que Looker no controla el orden en el que los navegadores envían eventos a las aplicaciones web. Esto significa que el orden de los eventos no está garantizado en todos los navegadores o plataformas. Asegúrate de escribir JavaScript correctamente para tener en cuenta el manejo de eventos de diferentes navegadores.

Puedes aprovechar JavaScript de dos maneras para el contenido incorporado de Looker:

Preparación

Para poder interactuar con el iframe incorporado, primero debes tomar las siguientes medidas:

Cómo agregar un ID al iframe

Una de las cosas que debe hacer más adelante es validar que la información con la que trabaja realmente proviene del iframe de Looker. Para facilitar este proceso, asegúrese de agregar un ID al iframe, si aún no lo hizo. En el siguiente ejemplo, agregamos id="looker":

<iframe id="looker" src="https://instance_name.looker.com/embed/dashboards/1"></iframe>

Agrega el dominio de incorporación al atributo iframe src

En el src del iframe, agrega el dominio en el que se usa el iframe. En el siguiente ejemplo, agregamos ?embed_domain=https://mywebsite.com":

<iframe
  id="looker"
  src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://mywebsite.com">
</iframe>

Si usas la incorporación de SSO, asegúrate de agregar embed_domain a la URL de incorporación.

No incluyas una barra diagonal final (/) en embed_domain.

Cómo agregar el dominio de incorporación a la lista de entidades permitidas

Por último, deberás agregar el dominio en el que se usa el iframe a la lista de entidades permitidas de la página Incorporar del panel Administrador de Looker:

  1. Ingresa el dominio en el que se usa el iframe. Después de escribirlo, asegúrese de presionar la tecla Tab para que el dominio aparezca en un cuadro. No incluyas una barra diagonal final (/) en la URL del dominio.
  2. Haz clic en el botón Actualizar.

Puedes usar el comodín * en la lista de entidades permitidas para crear un patrón de dominio. Por ejemplo, https://*.mycompany.com permitiría https://analytics.mycompany.com y https://data.mycompany.com.

Cómo recuperar datos del iframe

Después de completar los pasos de preparación, puedes acceder a los eventos pasados entre el iframe de Looker y tu dominio si escuchas eventos postMessage.

Asegúrate de verificar que los eventos provengan del iframe y del dominio de Looker para evitar mensajes maliciosos.

El iframe incorporado puede crear algunos tipos de eventos, como se describe en la sección Referencia de tipos de eventos de esta página.

Cómo acceder a eventos en JavaScript

Aquí hay un ejemplo de cómo escuchar estos eventos en JavaScript nativo y, luego, registrarlos en la consola:

window.addEventListener("message", function(event) {
  if (event.source === document.getElementById("looker").contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Este es un ejemplo de cómo escuchar estos eventos en jQuery y, luego, registrarlos en la consola:

$(window).on("message", function(event) {
  if (event.originalEvent.source === $("#looker")[0].contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Tabla de resumen del tipo de evento

En la siguiente tabla, se resumen los tipos de eventos. Haz clic en un tipo de evento para ver sus detalles.

Tipo de evento Causa del evento
dashboard:loaded En los paneles en los que los mosaicos no están configurados para ejecutarse automáticamente, se cargaron un panel y sus elementos, pero las consultas aún no se están ejecutando.
dashboard:run:start Se comenzó a cargar un panel y se comenzaron a cargar sus mosaicos y a consultar datos.
dashboard:run:complete Se terminó de ejecutar un panel y todos los mosaicos terminaron de cargarse y consultarse.
dashboard:download Se inició la descarga de un PDF de un panel.
dashboard:edit:start AGREGADO 22.20 Se cambió un panel al modo de edición. El evento dashboard:save:complete se activará cuando se guarde correctamente el panel. Esta opción no está disponible en paneles heredados.
dashboard:edit:cancel AGREGADO el 22.20 Se salió del panel en modo de edición sin guardar. Esta opción no está disponible en paneles heredados.
dashboard:save:complete Se editó y guardó un panel.
dashboard:delete:complete Se borró un panel.
dashboard:tile:start Se inició la carga de una tarjeta o la búsqueda de datos.
dashboard:tile:complete Una tarjeta terminó de ejecutar la consulta.
dashboard:tile:download Se comenzaron a descargar los datos de una tarjeta.
dashboard:tile:explore Un usuario hizo clic en la opción Explorar desde aquí en el mosaico de un panel.
dashboard:tile:view Un usuario hizo clic en la opción Ver diseño original en un mosaico de panel.
dashboard:filters:changed Se aplicaron o cambiaron los filtros de un panel.
look:ready Un estilo comenzó a cargar datos de consulta, independientemente de si esta se ejecutará o no.
look:run:start Una vista comenzó a cargar datos de la consulta y la consulta comenzó a ejecutarse.
look:run:complete Un estilo terminó de ejecutar la consulta.
look:save:complete Se editó y guardó un estilo.
look:delete:complete Se movió un estilo a la carpeta Papelera.
drillmenu:click Un usuario hizo clic en un menú de detalles de un panel que se creó con el parámetro de LookML link.
drillmodal:download Un usuario abrió un cuadro de diálogo de desglose desde la tarjeta de un panel e hizo clic en la opción Descargar.
drillmodal:explore Un usuario hizo clic en la opción Explorar desde aquí en un cuadro de diálogo de desglose.
explore:ready Se comenzó a cargar Explorar, ya sea que la consulta se ejecute o no.
explore:run:start Se comenzó a cargar la herramienta Explorar y esta se inició.
explore:run:complete Un explorador terminó de ejecutar la consulta.
explore:state:changed La URL de una página Explorar cambió como resultado de las acciones del usuario.
page:changed Un usuario navegó a una página nueva dentro del iframe.
page:properties:changed Cambió la altura del iframe de un panel.
session:tokens El cliente de Looker requiere tokens para continuar.
session:status Envía información sobre el estado de una sesión.

Referencia de tipo de evento

El iframe incorporado puede crear muchos tipos diferentes de eventos:

dashboard:loaded

En los paneles en los que los mosaicos no están configurados para ejecutarse automáticamente, este evento se crea después de que se cargan un panel y sus elementos, pero antes de que se ejecuten las consultas.

El atributo options no está disponible en paneles heredados.


type: "dashboard:loaded",
status: "complete",
dashboard: {
  id: 1,
  title: "Business Pulse",
  canEdit: true,
  dashboard_filters: {
    "date": "Last 6 Years",
    "state": ""
  },
  absoluteUrl: "https://self-signed.looker.com:9999/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  url: "/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Atributo Formato Descripción
status Cadena Indica si el panel y sus elementos se cargaron correctamente.
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.options Objeto Propiedades y valores del diseño del panel, el componente del diseño del panel y el elemento del panel Todas las propiedades que se muestran en el objeto options pueden recibir valores actualizados mediante el evento dashboard:options:set. Esta opción no está disponible en paneles heredados.

dashboard:run:start

Este evento se crea cuando comienza a cargarse un panel, cuando sus mosaicos comienzan a cargarse y a buscar datos.

type: "dashboard:run:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Atributo Formato Descripción
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:run:complete

Este evento se crea cuando se termina de ejecutar un panel y se terminan de cargar y consultar todos los mosaicos. Este evento se crea independientemente de si se cargaron correctamente todos los mosaicos.

Los atributos options y tileStatuses no están disponibles en los paneles heredados.

type: "dashboard:run:complete",
status: "complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://my.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Atributo Formato Descripción
status Cadena Indica si el panel y sus elementos se ejecutaron correctamente. Si el panel y sus elementos se ejecutaron correctamente, status muestra "complete". De lo contrario, status muestra "error". Si se detuvo el panel en ejecución, ya sea desde la interfaz de usuario o con la acción dashboard:stop, status mostrará "stopped".
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objeto Propiedades y valores del diseño del panel, el componente del diseño del panel y el elemento del panel Todas las propiedades que se muestran en el objeto options pueden recibir valores actualizados mediante la acción dashboard:options:set. Esta opción no está disponible en paneles heredados.
dashboard.tileStatuses Array de objetos Un array de objetos que proporcionan estados de tarjetas. Las propiedades del objeto son las siguientes:
  • tileId: Es el número de ID de la tarjeta.
  • status: Si la consulta de tarjeta se ejecutó correctamente, status muestra "complete"; de lo contrario, status muestra "error".
  • errors: Se propaga cuando la propiedad status es "error". Un array de objetos que proporcionan detalles del error, incluido el texto del mensaje de error, una descripción más detallada del error y la consulta en SQL del mosaico que produjo el error
Esta opción no está disponible en paneles heredados.

dashboard:download

Este evento se crea cuando se comienza a descargar un PDF de un panel.

type: "dashboard:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
fileFormat: "pdf"
Atributo Formato Descripción
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
fileFormat Cadena El formato del panel descargado (por el momento, solo "pdf").

dashboard:edit:start

AGREGAR 22.20 Este evento se crea cuando un panel se cambia al modo de edición.

Este evento no está disponible en los paneles heredados.

type: "dashboard:edit:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Atributo Formato Descripción
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:edit:cancel

AGREGAR 22.20 Este evento se crea cuando se sale de un panel que está en modo de edición sin guardarlo.

Este evento no está disponible en los paneles heredados.

type: "dashboard:edit:cancel",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Atributo Formato Descripción
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:save:complete

Este evento se crea cuando se edita y guarda un panel.

Este evento no está disponible en los paneles heredados.

type: "dashboard:save:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Atributo Formato Descripción
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.options Objeto Propiedades y valores del diseño del panel, el componente del diseño del panel y el elemento del panel Todas las propiedades que se muestran en el objeto options pueden recibir valores actualizados mediante el evento dashboard:options:set.

dashboard:delete:complete

Este evento se crea cuando se borra un panel.

Este evento no está disponible en los paneles heredados.

type: "dashboard:delete:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Atributo Formato Descripción
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.options Objeto Propiedades y valores del diseño del panel, el componente del diseño del panel y el elemento del panel Todas las propiedades que se muestran en el objeto options pueden recibir valores actualizados mediante el evento dashboard:options:set.

dashboard:tile:start

Este evento se crea cuando una tarjeta comienza a cargar o consultar datos.

type: "dashboard:tile:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Atributo Formato Descripción
dashboard.id Número/string El ID del panel al que pertenece el mosaico.
dashboard.title Cadena El título del panel, como se muestra en la parte superior del panel al que pertenece el mosaico.
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta de acceso) a la que pertenece el mosaico
dashboard.absoluteUrl Cadena La URL completa del panel al que pertenece el mosaico.
dashboard.dashboard_filters Objeto Son los filtros aplicados al panel al que pertenece el mosaico. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer El número de ID del evento, no la tarjeta.
tile.title Cadena El título de la tarjeta, como se muestra en la parte superior de la tarjeta.
tile.listen Objeto El panel global filtra esta tarjeta que escucha. Este objeto tiene el siguiente formato: {"Filter Label": "Filter Field", ...}

dashboard:tile:complete

Este evento se crea cuando una tarjeta termina de ejecutar la consulta.

El atributo errors no está disponible en paneles heredados.

type: "dashboard:tile:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
status: "complete",
truncated: false,
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Atributo Formato Descripción
dashboard.id Número/string El ID del panel al que pertenece el mosaico.
dashboard.title Cadena El título del panel, como se muestra en la parte superior del panel al que pertenece el mosaico.
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta de acceso) a la que pertenece el mosaico
dashboard.absoluteUrl Cadena La URL completa del panel al que pertenece el mosaico.
dashboard.dashboard_filters Objeto Son los filtros aplicados al panel al que pertenece el mosaico. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
status Cadena Si la consulta de mosaico se completó correctamente. Los valores posibles son "complete" o "error".
truncated Booleano Indica si los resultados de la consulta de mosaicos se truncaron como resultado de una consulta que muestra más filas que el límite de filas de la consulta. El límite de filas puede ser un límite de filas especificado por el usuario o el límite predeterminado de 5,000 filas de Looker.
tile.id Integer El número de ID del evento, no la tarjeta.
tile.title Cadena El título de la tarjeta, como se muestra en la parte superior de la tarjeta.
tile.listen Objeto El panel global filtra esta tarjeta que escucha. Este objeto tiene el siguiente formato: {"Filter Label": "Filter Field", ...}
tile.errors Array de objetos Se propaga cuando la propiedad status es "error". Un array de objetos que proporcionan detalles del error, incluido el texto del mensaje de error, una descripción más detallada del error y la consulta en SQL del mosaico que produjo el error Esta opción no está disponible en paneles heredados.

dashboard:tile:download

Este evento se crea cuando comienzan a descargarse los datos de una tarjeta.

type: "dashboard:tile:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales"
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
fileFormat: "pdf"
Atributo Formato Descripción
dashboard.id Número/string El ID del panel al que pertenece el mosaico.
dashboard.title Cadena El título del panel, como se muestra en la parte superior del panel al que pertenece el mosaico.
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta de acceso) a la que pertenece el mosaico
dashboard.absoluteUrl Cadena La URL completa del panel al que pertenece el mosaico.
dashboard.dashboard_filters Objeto Son los filtros aplicados al panel al que pertenece el mosaico. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer El número de ID del evento, no la tarjeta.
tile.title Cadena El título de la tarjeta, como se muestra en la parte superior de la tarjeta.
tile.listen Objeto El panel global filtra esta tarjeta que escucha. Este objeto tiene el siguiente formato: {"Filter Label": "Filter Field", ...}
fileFormat Cadena El formato de la tarjeta descargada (por el momento, solo "pdf").

dashboard:tile:explore

Este evento se crea cuando un usuario hace clic en la opción Explorar desde aquí en un mosaico del panel.

type: "dashboard:tile:explore",
label: 'Explore From Here',
url: '/embed/explore/model/view...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Atributo Formato Descripción
label Cadena La etiqueta del botón.
url Cadena La URL relativa (solo la ruta) de Explorar que se mostrará.
dashboard.id Número/string El ID del panel al que pertenece el mosaico.
dashboard.title Cadena El título del panel, como se muestra en la parte superior del panel al que pertenece el mosaico.
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta de acceso) a la que pertenece el mosaico
dashboard.absoluteUrl Cadena La URL completa del panel al que pertenece el mosaico.
dashboard.dashboard_filters Objeto Son los filtros aplicados al panel al que pertenece el mosaico. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer El número de ID del evento, no la tarjeta.
tile.title Cadena El título de la tarjeta, como se muestra en la parte superior de la tarjeta.
tile.listen Objeto El panel global filtra esta tarjeta que escucha. Este objeto tiene el siguiente formato: {"Filter Label": "Filter Field", ...}

dashboard:tile:view

Este evento se crea cuando un usuario hace clic en la opción Ver diseño original en un mosaico de panel.

type: "dashboard:tile:view",
label: 'View Original Look',
url: '/embed/look/...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Atributo Formato Descripción
label Cadena La etiqueta del botón.
url Cadena La URL relativa (solo la ruta de acceso) del estilo que se verá.
dashboard.id Número/string El ID del panel al que pertenece el mosaico.
dashboard.title Cadena El título del panel, como se muestra en la parte superior del panel al que pertenece el mosaico.
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta de acceso) a la que pertenece el mosaico
dashboard.absoluteUrl Cadena La URL completa del panel al que pertenece el mosaico.
dashboard.dashboard_filters Objeto Son los filtros aplicados al panel al que pertenece el mosaico. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer El número de ID del evento, no la tarjeta.
tile.title Cadena El título de la tarjeta, como se muestra en la parte superior de la tarjeta.
tile.listen Objeto El panel global filtra esta tarjeta que escucha. Este objeto tiene el siguiente formato: {"Filter Label": "Filter Field", ...}

dashboard:filters:changed

Este evento se crea cuando se aplican o se modifican los filtros de un panel.

El atributo options no está disponible en paneles heredados.

type: "dashboard:filters:changed",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Atributo Formato Descripción
dashboard.id Número/string Es el ID del panel.
dashboard.title Cadena El título, como se muestra en la parte superior del panel
dashboard.canEdit Booleano AGREGADO el 22.20 Cuando el valor es true, el usuario puede editar el panel. Esta opción no está disponible en paneles heredados.
dashboard.url Cadena La URL relativa del panel (solo la ruta)
dashboard.absoluteUrl Cadena La URL completa del panel.
dashboard.dashboard_filters Objeto Los filtros aplicados al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objeto Propiedades y valores del diseño del panel, el componente del diseño del panel y el elemento del panel Todas las propiedades que se muestran en el objeto options pueden recibir valores actualizados mediante el evento dashboard:options:set. Esta opción no está disponible en paneles heredados.

look:ready

Este evento se crea cuando una vista comienza a cargar datos de consulta, sin importar si la consulta se ejecuta o no.

type: "look:ready",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Atributo Formato Descripción
look.url Cadena La URL de aspecto relativa (solo la ruta)
look.absoluteUrl Cadena La URL completa de Look

look:run:start

Este evento se crea cuando una vista comienza a cargar datos de consulta y la consulta comienza a ejecutarse.

type: "look:run:start",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Atributo Formato Descripción
look.url Cadena La URL de aspecto relativa (solo la ruta)
look.absoluteUrl Cadena La URL completa de Look

look:run:complete

Este evento se crea cuando una vista termina de ejecutar la consulta.

type: look:run:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Atributo Formato Descripción
look.url Cadena La URL de aspecto relativa (solo la ruta)
look.absoluteUrl Cadena La URL completa de Look

look:save:complete

Este evento se crea cuando se edita y se guarda un estilo. Este evento se crea cuando un usuario realiza una de las siguientes tareas:

Este evento no se crea si la apariencia se guarda con la opción de menú Guardar > En el panel existente o Editar configuración.

type: look:save:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  spaceId: 123
  }
}
Atributo Formato Descripción
look.url Cadena La URL de aspecto relativa (solo la ruta)
look.absoluteUrl Cadena La URL completa de Look
look.spaceID Integer El ID de la carpeta en la que se almacena la imagen

look:delete:complete

Este evento se crea cuando una apariencia se mueve a la carpeta Papelera.

type: look:delete:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Atributo Formato Descripción
look.url Cadena La URL de aspecto relativa (solo la ruta)
look.absoluteUrl Cadena La URL completa de Look

drillmenu:click

Este evento se crea cuando un usuario hace clic en un menú de desglose de un panel creado con el parámetro de LookML link. Por ejemplo, el siguiente LookML crea un menú de desglose en el que un usuario puede ver datos filtrados por la dimensión state:


dimension: state {
  type: string
  sql: ${TABLE}.state ;;
  link: {
    label: "Filter by {{ state | encode_uri }}"
    url: "filter::q={{ state | encode_uri }}"
    icon_url: "https://google.com/favicon.ico"
  }
}

Cuando el filtro state se establece en Illinois, el evento drillmenu:click muestra lo siguiente al host del iframe:

type: "drillmenu:click",
label: "Filter by Illinois",
link_type: "url",
modal: false,
target: '_self',
url: "#filter::state=Illinois"
context: ' '
Atributo Formato Descripción
label Cadena La etiqueta de vínculo, como se muestra en el menú de detalles
link_type Cadena El tipo de objeto en el destino del vínculo
modal Booleano Si se usará el cuadro de diálogo de búsqueda en lugar de la navegación en el navegador
target Cadena Es _self si el destino del vínculo reemplazará el iframe actual. Si el destino del vínculo abrirá una ventana nueva, será _blank.
url Cadena La URL de destino del vínculo
context Cadena Atributo interno que usan algunos tipos de visualizaciones

Si utiliza la zona de pruebas, el iframe evitará que se abran los clics del menú de búsqueda en una ventana nueva. Usa estos valores de zona de pruebas dentro de la etiqueta iframe:

sandbox = "allow-same-origin allow-scripts"

drillmodal:download

Este evento se crea cuando un usuario abre un cuadro de diálogo de información desde un mosaico de panel y hace clic en la opción Descargar.

{
type: "drillmodal:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/…",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/…",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
drillExploreUrl: "/embed...",
fileFormat: "pdf"
}
Atributo Formato Descripción
dashboard.id Número/string El ID del panel al que pertenece el mosaico.
dashboard.title Cadena El título del panel, como se muestra en la parte superior del panel al que pertenece el mosaico.
dashboard.url Cadena La URL relativa del panel (solo la ruta de acceso) a la que pertenece el mosaico
dashboard.absoluteUrl Cadena La URL completa del panel al que pertenece el mosaico.
dashboard.dashboard_filters Objeto Son los filtros aplicados al panel al que pertenece el mosaico. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
drillExploreUrl Cadena La URL de Explorar relativa (solo la ruta de acceso) que se descargará.
fileFormat Cadena El formato de archivo de la descarga de datos.

drillmodal:explore

Este evento se crea cuando un usuario hace clic en la opción Explorar desde aquí en un cuadro de diálogo de consulta.

type: "drillmodal:explore",
label: "Explore From Here",
url: "/embed/explore/model/view..."
Atributo Formato Descripción
label Cadena La etiqueta del botón como se muestra en el menú de detalles
url Cadena La URL de Explorar relativa (solo la ruta) que se verá.

explore:ready

Este evento se crea cuando Explorar comienza a cargar datos de consultas, sin importar si la consulta se ejecuta o no.

type: "explore:ready",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}
Atributo Formato Descripción
explore.url Cadena La URL de Explorar relativa (solo la ruta de acceso)
explore.absoluteUrl Cadena La URL completa de Explorar

explore:run:start

Este evento se crea cuando Explorar comienza a cargar datos de consulta y la consulta comienza a ejecutarse.

type: "explore:run:start",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}
Atributo Formato Descripción
explore.url Cadena La URL de Explorar relativa (solo la ruta de acceso)
explore.absoluteUrl Cadena La URL completa de Explorar

explore:run:complete

Este evento se crea cuando un objeto Explorer termina de ejecutar la consulta.

type: "explore:run:complete",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}
Atributo Formato Descripción
explore.url Cadena La URL de Explorar relativa (solo la ruta de acceso)
explore.absoluteUrl Cadena La URL completa de Explorar

explore:state:changed

Este evento se crea cuando una URL de la página Explorar cambia como resultado de las acciones del usuario.

type: "explore:state:changed",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/..."
}
Atributo Formato Descripción
explore.url Cadena La URL de Explorar relativa (solo la ruta de acceso)
explore.absoluteUrl Cadena La URL completa de Explorar

page:changed

Este evento se crea cuando un usuario navega a una página nueva dentro del iframe.

type: "page:changed",
page: {
  type: "dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/..."
}
Atributo Formato Descripción
page.type Cadena El tipo de página al que se acaba de navegar, como "dashboard", "look" o "explore"
page.url Cadena La URL relativa (solo la ruta) de la página a la que se acaba de navegar
page.absoluteUrl Cadena La URL completa de la página a la que se acaba de navegar

page:properties:changed

Este evento se crea cuando cambia la altura del iframe de un panel. No está disponible para la función Explorar o Explorar, ya que esos elementos ajustan automáticamente su altura al tamaño del iframe.

type: "page:properties:changed",
height: 1000
Atributo Formato Descripción
height Integer La altura del iframe del panel en píxeles

session:tokens

Este evento indica que el cliente de Looker requiere tokens para continuar. Este evento se crea inmediatamente después de crear el iframe y periódicamente durante la sesión.

{
  "type": "session:tokens",
  "api_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoiYXBpX3Rva2VuIiwicmFuZG9taXplciI6IkxjYnpOeDNTVjNOb3o3UVlqTVJjNmhlMkdodjh1a2UwWUhiZWNRMHVCYm1KIn0.CBv1__QGc_H7bKNe31SHMMQCsc5ya1xOiEv1UDWAyxM",
  "api_token_ttl": 463,
  "navigation_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoibmF2aWdhdGlvbl90b2tlbiIsInJhbmRvbWl6ZXIiOiJHVVNlc00tdTRPRDlNdktodFJDU2pEcVFhUkJNeTh5dm42Q1FDUXhuLTNxMiJ9.sWo7LUEI5LeragVmeDamUR7u2myXpFJ0aqK_IIALUqI",
  "navigation_token_ttl": 463,
  "session_reference_token_ttl": 2924
}
Atributo Formato Descripción
authentication_token Cadena Token de autenticación Se incluye cuando se crea el iframe. No se incluye en una respuesta a una solicitud para generar tokens o si la sesión venció.
authentication_token_ttl Número Es el tiempo de actividad del token de autenticación en segundos. Se incluye cuando se crea el iframe. No se incluye en una respuesta a una solicitud para generar tokens o si la sesión venció.
api_token Cadena Token de API No se incluye si la sesión venció.
api_token_ttl Número Es el tiempo de actividad del token de la API en segundos. No se incluye si la sesión venció.
navigation_token Cadena Token de navegación No se incluye si la sesión venció.
navigation_token_ttl Número Tiempo de uso del token de navegación en segundos No se incluye si la sesión venció.
session_references_token_ttl Número Duración de la sesión en segundos. El valor será 0 cuando venza la sesión. Para recuperarla, la aplicación de incorporación debe adquirir una sesión nueva.

session:status

El evento se genera cuando la aplicación de Looker incorporada controla las solicitudes de tokens de sesión.

{
  "type": "session:status",
  "session_ttl": 0,
  "expired": true,
  "interrupted": false
}
Atributo Formato Descripción
session_ttl Número Duración de la sesión en segundos.
expired Booleano Cuando true, indica que la sesión venció.
interrupted Booleano Cuando true, indica que no se respondió una solicitud de tokens de sesión. Esto podría indicar que un servidor no está disponible temporalmente.
recoverable Booleano Solo se propaga cuando se interrumpe: true. Indica si la sesión se puede recuperar o no. Un valor de false probablemente significa que hay un problema con la aplicación de incorporación.

Cómo realizar cambios en el iframe

Después de preparar tu iframe para la recuperación de datos, sigue estos pasos:

  1. Escribe tu solicitud en JSON.
  2. Publica la solicitud en el contentWindow del iframe.

Cómo escribir tu solicitud en JSON

Puedes realizar varios cambios en el iframe, que enviarás en formato JSON. Las opciones disponibles se describen en la sección Referencia de acciones de esta página. No olvides usar JSON.stringify para convertir tu acción en JSON, como se muestra a continuación:

var my_request = JSON.stringify(
  {
    type: "dashboard:run"
  }
);

Cómo publicar la solicitud en la propiedad contentWindow del iframe

Por último, publica tu mensaje en el contentWindow del iframe de la siguiente manera:

var my_iframe = document.getElementById("my_iframe_id");

my_iframe.contentWindow.postMessage(my_request, 'https://instance_name.looker.com');

Tabla de resumen de acciones

En la siguiente tabla, se resumen las acciones. Haz clic en una acción para ver sus detalles.

Acción Descripción de la acción
dashboard:load Carga un panel nuevo en el iframe y reemplaza un panel existente.
dashboard:run Ejecuta el panel en el iframe.
dashboard:edit ADDED 22.20 Cambia el panel al modo de edición. Esta acción no está disponible en los paneles heredados.
dashboard:filters:update Actualiza un filtro de panel existente en el iframe.
dashboard:options:set Escribe nuevos valores para el diseño y las propiedades del elemento del panel.
dashboard:schedule_modal:open Abre el Programador, que permite a los usuarios entregar contenido de Looker a varios destinos.
dashboard:stop Detiene un panel que está ejecutando o volviendo a cargar datos.
look:run Ejecuta el Look en el iframe.
look:filters:update Actualiza un filtro de aspecto existente en el iframe.
explore:run Ejecuta Explorar en el iframe.
explore:filters:update Actualiza o quita un filtro Explorar existente en el iframe.
session:tokens:request Envía tokens en respuesta a un evento session:tokens:request.

Referencia de la acción

Estas son las acciones disponibles que puedes publicar en el iframe incorporado:

dashboard:load

Esta acción no está disponible en los paneles heredados.

Usa esta acción para cargar un panel nuevo en el iframe y reemplazar uno existente. El nuevo panel comenzará a ejecutar consultas como si se hubiera abierto una nueva página de panel.

{
  type: "dashboard:load",
  id: "101",
  pushHistory: false
}
Atributo Formato Descripción
type Cadena Usar el tipo dashboard:load indica que quieres cargar un nuevo panel en el iframe.
id Cadena El ID del panel que se cargará.
pushHistory Booleano Si es true, el panel cargado crea una nueva entrada del historial del navegador, y el usuario puede usar el botón Atrás del navegador para regresar al panel anterior. Si es false, se reemplaza el panel actual y no se puede usar la navegación del navegador para regresar a él.

dashboard:run

Usa esta acción para ejecutar el panel en el iframe. Es la misma acción que hacer clic en el botón Run o Reload Data del panel.

{
  type: "dashboard:run"
}
Atributo Formato Descripción
type Cadena Usar el tipo dashboard:run indica que quieres ejecutar el panel.

dashboard:edit

AGREGADO 22.20 Usa esta acción para cambiar un panel existente del iframe al modo de edición. Esto es lo mismo que seleccionar Editar panel en el menú del panel.

Esta acción no está disponible en los paneles heredados.

{
  type: "dashboard:edit"
}
Atributo Formato Descripción
type Cadena Si usas el tipo dashboard:edit, indicas que quieres cambiar el panel al modo de edición.

dashboard:filters:update

Usa esta acción para actualizar un filtro de panel existente en el iframe. No puedes agregar un filtro nuevo al panel mediante este método.

{
  type: "dashboard:filters:update",
  filters: {
    "Sale date": "Last 28 days",
    "Sale amount": "Greater than 100"
  }
}
Atributo Formato Descripción
type Cadena Si usas el tipo dashboard:filters:update, indicas que quieres actualizar los filtros que usa el panel.
filters Objeto Los nuevos filtros que desea aplicar al panel. Este objeto tiene el siguiente formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:options:set

Esta acción está disponible después de que ocurre el evento dashboard:run:complete y no está disponible en los paneles heredados.

El agregador crea el mensaje y lo envía al iframe, pero el panel no responde hasta después de que se produce dashboard:run:complete. La acción dashboard:options:set escribe valores nuevos en el diseño del panel y en las propiedades del elemento del panel. Solo las propiedades que se mostraron en el atributo options del evento dashboard:run:complete se pueden actualizar con dashboard:options:set. Se ignoran todas las propiedades que no se mostraron anteriormente mediante el atributo options del evento dashboard:run:complete.

{
  type: "dashboard:options:set",
  layouts: [
    {
      id: 1,
      dashboard_id: 1,
      type: "newspaper",
      active: true,
      column_width: null,
      width: null,
      deleted: false,
      dashboard_layout_components: [
        {
          id: 1,
          dashboard_layout_id: 1,
          dashboard_element_id: 1,
          row: 0,
          column: 0,
          width: 8,
          height: 4,
          deleted: false
        },
        {
          id: 2,
          dashboard_layout_id: 1,
          dashboard_element_id: 2,
          row: 0,
          column: 8,
          width: 8,
          height: 4,
          deleted: false
        }
      ]
    }
  ],
  elements: {
    1: {
      title: "Total Orders",
      title_hidden: false,
      vis_config: {
        type: "single_value",
        font_size: "medium",
        title: "Total Orders"
      }
    },
    2: {
      title: "Average Order Profit",
      title_hidden: false,
      vis_config: {
        type: "single_value",
        title: "Average Order Profit"
      }
    }
  }
}
Atributo Formato Descripción
type Cadena Usar el tipo dashboard:options:set indica que deseas escribir valores nuevos en el diseño del panel y en las propiedades del elemento del panel.
layouts Objeto Las propiedades de diseño del panel que muestra el atributo options en el evento dashboard:run:complete Tendrán un formato similar a este:

id: "string",
dashboard_id: "string",
type: "newspaper",
active: boolean,
column_width: number,
width: number
layouts.dashboard_layout_components Objeto Uno o más objetos de componentes de diseño de panel que muestra el atributo options en el evento dashboard:run:complete. Tendrán un formato similar a este:

id: "string",
dashboard_layout_id: "string",
dashboard_element_id: "string",
row: number,
column: number,
width: number,
height: number,
deleted: boolean,
elements Objeto Uno o más objetos de elemento de panel que muestra el atributo options en el evento dashboard:run:complete. Tendrán un formato similar a este:

id: {
  title: "string"

dashboard:schedule_modal:open

Usa esta acción para abrir el programador, lo que permite a los usuarios entregar contenido de Looker a varios destinos.

Esta acción no está disponible en los paneles heredados.

{
  type: "dashboard:schedule_modal:open"
}
Atributo Formato Descripción
type Cadena Si usas el tipo dashboard:schedule_modal:open, indicas que quieres abrir el cuadro de diálogo Schedule.

dashboard:stop

Usa esta acción para detener un panel que esté ejecutando o volviendo a cargar datos. Es la misma acción que hacer clic en el botón Cancel del panel. Un panel que deja de usar dashboard:stop envía un evento dashboard:run:complete con status: establecido en "stopped".

Esta acción no está disponible en los paneles heredados.

{
  type: "dashboard:stop"
}
Atributo Formato Descripción
type Cadena Si usas el tipo dashboard:stop, indicas que deseas detener el panel en ejecución.

look:run

Usa esta acción para ejecutar la consulta en la que se basa el Look en el iframe. Esto es similar a presionar el botón Run en Look, con la excepción de que look:run siempre consulta la base de datos de forma directa y no recupera datos de la caché de Looker.

{
  type: "look:run"
}
Atributo Formato Descripción
type Cadena Usar el tipo look:run indica que deseas ejecutar el estilo.

look:filters:update

Usa esta acción para actualizar un filtro de aspecto existente en el iframe. No puedes agregar un filtro nuevo a la apariencia usando este método.

{
  type: "look:filters:update",
  filters: {
    "orders.created_at": "90 days",
    "products.department": "sweaters"
  }
}
Atributo Formato Descripción
type Cadena Usar el tipo look:filters:update indica que quieres actualizar los filtros que usa el estilo.
filters Objeto Los nuevos filtros que quieres aplicar a la apariencia. Este objeto tiene el siguiente formato: {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}

explore:run

Usa esta acción para ejecutar Explorar en el iframe. Esto es similar a presionar el botón Run en Explorar, con la excepción de que explore:run siempre consulta la base de datos de forma directa y no recupera datos de la caché de Looker.

{
  type: "explore:run"
}
Atributo Formato Descripción
type Cadena Si usas el tipo explore:run, indicas que quieres ejecutar Explorar.

explore:filters:update

Usa esta acción para actualizar o quitar un filtro Explorar existente en el iframe. Si agregas un filtro nuevo que haga referencia a un campo válido, se agregará el filtro nuevo a Explorar.

{
  type: "explore:filters:update",
  filters: {
    "orders.created_at": "90 days",
    "orders.status": "complete"
  }
  deleteFilters:  ["products.department"]
}
Atributo Formato Descripción
type Cadena Si usas el tipo explore:filters:update, indicas que quieres actualizar los filtros que usa Explorar.
filters Objeto Los nuevos filtros que desea aplicar a Explorar. Si filters incluye un filtro que no existe actualmente en Explorar, pero que hace referencia a un campo válido, se agregará a Explorar. Este objeto tiene el siguiente formato: {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}
deleteFilters Array Los filtros existentes que deseas quitar de Explorar. El array tiene el siguiente formato: ["view_name.field_name_1", "view_name.field_name_2", ...]

session:tokens:request

Usa esta acción para enviar tokens en respuesta a una solicitud session:tokens:request.

{
  type: "session:tokens:request",
}
Atributo Formato Descripción
type Cadena Usar el tipo session:tokens:request indica que deseas enviar tokens en respuesta a un evento session:tokens:request.