Depois de criar uma incorporação, isso pode ser feito de forma pública, privada, com Logon único (SSO) ou pela API, você pode interagir com esses iframes por meio de JavaScript. É possível tornar sua página mais dinâmica, com base no status do item incorporado, ou até mesmo fazer alterações no item incorporado a partir de sua página da Web.
O Looker não controla a ordem em que os navegadores enviam eventos para aplicativos da Web. Isso significa que a ordem dos eventos não é garantida em navegadores ou plataformas. Escreva seu JavaScript corretamente para lidar com o tratamento de eventos de diferentes navegadores.
Há duas maneiras de usar JavaScript no conteúdo incorporado do Looker:
- Usando o kit de desenvolvimento de software (SDK) incorporado do Looker, descrito na página de documentação SDK incorporado
- Como usar eventos JavaScript, descritos na seção Como acessar eventos no JavaScript nesta página
Preparação
Você precisa realizar algumas ações antes de interagir com o iframe incorporado:
- Adicionar um ID ao iframe
- Adicionar o domínio de incorporação ao atributo Iframe
src
- Adicionar o domínio incorporado à lista de permissões
Como adicionar um ID ao iframe
Uma das coisas que você precisará fazer mais tarde é validar se as informações com as quais está trabalhando realmente vêm do iframe do Looker. Para facilitar, adicione um ID ao iframe, caso ainda não tenha feito isso. No exemplo a seguir, adicionamos id="looker"
:
<iframe id="looker" src="https://instance_name.looker.com/embed/dashboards/1"></iframe>
Como adicionar o domínio incorporado ao atributo de iframe src
No src
do iframe, adicione o domínio em que o iframe está sendo usado. No exemplo a seguir, adicionamos ?embed_domain=https://mywebsite.com"
:
<iframe
id="looker"
src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://mywebsite.com">
</iframe>
Se você usar a incorporação de SSO, adicione embed_domain
ao URL de incorporação.
Não inclua uma barra final (
/
) noembed_domain
.
Como adicionar o domínio incorporado à lista de permissões
Por fim, você precisa adicionar o domínio em que o iframe está sendo usado à lista de permissões na página Incorporar do painel Administrador do Looker:
- Insira o domínio em que o iframe está sendo usado. Depois de digitá-lo, pressione a tecla Tab para que o domínio apareça em uma caixa. Não inclua uma barra final (
/
) no URL do domínio. - Clique no botão Atualizar.
Você pode usar o caractere curinga *
na lista de permissões para criar um padrão de domínio. Por exemplo, https://*.mycompany.com
permitiria https://analytics.mycompany.com
e https://data.mycompany.com
.
Se você estiver usando a incorporação sem cookies com o Looker 23.8 ou posterior, o domínio de incorporação poderá ser especificado quando a sessão sem cookies for adquirida. Essa é uma alternativa à adição à lista de permissões usando o painel Administrador > Incorporar. Analise as práticas recomendadas de segurança se você decidir aproveitar esse recurso.
Como recuperar dados do iframe
Depois de concluir as etapas de preparação, você vai poder acessar os eventos transmitidos entre o iframe do Looker e o domínio ouvindo eventos postMessage
.
Verifique se os eventos vieram do iframe e do domínio do Looker para evitar mensagens maliciosas.
O iframe incorporado pode criar alguns tipos de evento, conforme descrito na seção Referência de tipo de evento desta página.
Como acessar eventos em JavaScript
Veja um exemplo de como detectar esses eventos em JavaScript nativo e de registrá-los no console:
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));
}
}
});
Veja um exemplo de como detectar esses eventos no jQuery e de registrá-los no console:
$(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));
}
}
});
Tabela de resumo do tipo de evento
A tabela a seguir resume os tipos de evento. Clique em um tipo de evento para ver os detalhes sobre ele.
Tipo de evento | Causa do evento |
---|---|
dashboard:loaded |
Em painéis nos quais os blocos não estão configurados para execução automática, um painel e seus elementos foram carregados, mas as consultas ainda não estão em execução. |
dashboard:run:start |
Um painel começou a carregar, e os blocos começaram a carregar e consultar dados. |
dashboard:run:complete |
Um painel foi executado, e o carregamento e a consulta de todos os blocos foram concluídos. |
dashboard:download |
O download do PDF de um painel começou. |
dashboard:edit:start |
ADDED 22.20
Um painel foi alternado para o modo de edição. O evento dashboard:save:complete será acionado quando o painel for salvo. |
dashboard:edit:cancel |
ADDED 22.20 Um painel que está no modo de edição saiu do modo de edição sem salvar. |
dashboard:save:complete |
Um painel foi editado e salvo. |
dashboard:delete:complete |
Um painel foi excluído. |
dashboard:tile:start |
Um bloco começou a carregar ou consultar dados. |
dashboard:tile:complete |
Um bloco terminou de executar a consulta. |
dashboard:tile:download |
O download dos dados de um bloco começou. |
dashboard:tile:explore |
Um usuário clicou na opção Explorar a partir daqui em um bloco do painel. |
dashboard:tile:view |
Um usuário clicou na opção Ver aparência original em um bloco do painel. |
dashboard:filters:changed |
Os filtros de um painel foram aplicados ou alterados. |
look:ready |
Uma aparência começou a carregar dados de consulta, independentemente de a consulta ser executada ou não. |
look:run:start |
Uma aparência começou a carregar dados de consulta e a consulta começou a ser executada. |
look:run:complete |
Uma consulta terminou de executar a consulta. |
look:save:complete |
Um visual foi editado e salvo. |
look:delete:complete |
Um look foi movido para a pasta Lixeira. |
drillmenu:click |
Um usuário clicou em um menu de detalhamento em um painel criado com o parâmetro link LookML. |
drillmodal:download |
Um usuário abriu uma caixa de diálogo de detalhamento em um bloco do painel e clicou na opção Download. |
drillmodal:explore |
Um usuário clicou na opção Explorar a partir daqui em uma caixa de diálogo de detalhamento. |
explore:ready |
Uma exploração começou a carregar dados de consultas, mesmo que elas não sejam executadas. |
explore:run:start |
Uma exploração começou a carregar dados de consulta, e a consulta começou a ser executada. |
explore:run:complete |
Uma consulta foi concluída. |
explore:state:changed |
Um URL da página "Explorar" foi alterado como resultado das ações do usuário. |
page:changed |
Um usuário navegou para uma nova página no iframe. |
page:properties:changed |
A altura de um iframe do painel mudou. |
session:tokens |
O cliente do Looker precisa de tokens para continuar. |
session:status |
Envia informações sobre o status de uma sessão. |
env:client:dialog |
Foi aberta uma caixa de diálogo que pode estar parcialmente fora de vista, como uma caixa de diálogo de detalhamento. Esse evento permite que o aplicativo de hospedagem role a caixa de diálogo para visualizar. |
Referência do tipo de evento
O iframe incorporado pode criar muitos tipos diferentes de eventos:
dashboard:loaded
Em painéis em que os blocos não estão configurados para execução automática, esse evento é criado após o carregamento de um painel e dos elementos dele, mas antes da execução das consultas.
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 | Descrição |
---|---|---|
status |
String | Indica se o painel e seus elementos foram carregados. |
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.options |
Objeto | As propriedades e os valores de layout do painel, componente do painel e elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set . |
dashboard:run:start
Este evento é criado quando um painel começa a carregar, quando os blocos começam a carregar e consultar dados.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:run:complete
Este evento é criado quando a execução de um painel é concluída e todos os blocos são carregados e consultados. Este evento é criado independentemente de todos os blocos serem carregados ou não.
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 | Descrição |
---|---|---|
status |
String | Indica se o painel e seus elementos foram executados. Se o painel e os elementos dele tiverem sido executados, status retornará "complete" . Caso contrário, status retornará "error" . Se o painel em execução tiver sido interrompido na interface do usuário ou com a ação dashboard:stop , status vai retornar "stopped" . |
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.options |
Objeto | As propriedades e os valores de layout do painel, componente do painel e elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando a ação dashboard:options:set . |
dashboard.tileStatuses |
Matriz de objetos | Uma matriz de objetos com status de bloco. As propriedades do objeto são:
|
dashboard:download
Este evento é criado quando o download de um PDF de um painel é iniciado.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
fileFormat |
String | O formato do painel transferido por download (somente "pdf" no momento). |
dashboard:edit:start
ADDED 22.20 Este evento é criado quando um painel é alterado para o modo de edição.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:edit:cancel
ADDED 22.20 Este evento é criado quando um painel que está no modo de edição sai do modo de edição sem salvar.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:save:complete
Este evento é criado quando um painel é editado e salvo.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.options |
Objeto | As propriedades e os valores de layout do painel, componente do painel e elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set . |
dashboard:delete:complete
Este evento é criado quando um painel é excluído.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.options |
Objeto | As propriedades e os valores de layout do painel, componente do painel e elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set . |
dashboard:tile:start
Este evento é criado quando um bloco começa a carregar ou consultar dados.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel ao qual o bloco pertence. |
dashboard.title |
String | O título do painel, como mostrado na parte superior do painel ao qual o bloco pertence. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL do painel relativo (apenas o caminho) ao qual o bloco pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel ao qual o bloco pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel ao qual o bloco pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Inteiro | O número do ID do evento, não o bloco. |
tile.title |
String | O título do bloco, como mostrado na parte superior do bloco. |
tile.listen |
Objeto | O painel global filtra o bloco que está detectando. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
dashboard:tile:complete
Este evento é criado quando um bloco termina de executar a consulta.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel ao qual o bloco pertence. |
dashboard.title |
String | O título do painel, como mostrado na parte superior do painel ao qual o bloco pertence. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL do painel relativo (apenas o caminho) ao qual o bloco pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel ao qual o bloco pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel ao qual o bloco pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
status |
String | Se a consulta de bloco foi concluída com sucesso. Os valores possíveis são "complete" ou "error" . |
truncated |
Booleano | Se os resultados da consulta de bloco foram truncados como resultado da consulta retornar mais linhas do que o limite de linhas da consulta. O limite de linhas pode ser um limite especificado pelo usuário ou 5.000. |
tile.id |
Inteiro | O número do ID do evento, não o bloco. |
tile.title |
String | O título do bloco, como mostrado na parte superior do bloco. |
tile.listen |
Objeto | O painel global filtra o bloco que está detectando. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
tile.errors |
Matriz de objetos | Preenchido quando a propriedade status é "error" . Uma matriz de objetos com detalhes do erro, incluindo o texto da mensagem, uma descrição mais detalhada do erro e a consulta SQL do bloco que produziu o erro. |
dashboard:tile:download
Este evento é criado quando o download dos dados de um bloco é iniciado.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel ao qual o bloco pertence. |
dashboard.title |
String | O título do painel, como mostrado na parte superior do painel ao qual o bloco pertence. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL do painel relativo (apenas o caminho) ao qual o bloco pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel ao qual o bloco pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel ao qual o bloco pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Inteiro | O número do ID do evento, não o bloco. |
tile.title |
String | O título do bloco, como mostrado na parte superior do bloco. |
tile.listen |
Objeto | O painel global filtra o bloco que está detectando. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
fileFormat |
String | O formato do bloco baixado (apenas "pdf" no momento). |
dashboard:tile:explore
Este evento é criado quando um usuário clica na opção Explorar a partir daqui em um bloco do painel.
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 | Descrição |
---|---|---|
label |
String | O rótulo do botão. |
url |
String | O URL relativo (apenas o caminho) da exploração a ser visualizada. |
dashboard.id |
Número/string | O ID do painel ao qual o bloco pertence. |
dashboard.title |
String | O título do painel, como mostrado na parte superior do painel ao qual o bloco pertence. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL do painel relativo (apenas o caminho) ao qual o bloco pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel ao qual o bloco pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel ao qual o bloco pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Inteiro | O número do ID do evento, não o bloco. |
tile.title |
String | O título do bloco, como mostrado na parte superior do bloco. |
tile.listen |
Objeto | O painel global filtra o bloco que está detectando. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
dashboard:tile:view
Este evento é criado quando um usuário clica na opção Ver aparência original em um bloco do painel.
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 | Descrição |
---|---|---|
label |
String | O rótulo do botão. |
url |
String | O URL relativo (apenas o caminho) da aparência a ser visualizada. |
dashboard.id |
Número/string | O ID do painel ao qual o bloco pertence. |
dashboard.title |
String | O título do painel, como mostrado na parte superior do painel ao qual o bloco pertence. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL do painel relativo (apenas o caminho) ao qual o bloco pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel ao qual o bloco pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel ao qual o bloco pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Inteiro | O número do ID do evento, não o bloco. |
tile.title |
String | O título do bloco, como mostrado na parte superior do bloco. |
tile.listen |
Objeto | O painel global filtra o bloco que está detectando. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
dashboard:filters:changed
Este evento é criado quando os filtros de um painel são aplicados ou alterados.
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel. |
dashboard.title |
String | O título, conforme mostrado na parte superior do painel. |
dashboard.canEdit |
Booleano |
ADDED 22.20
Quando true , o usuário pode editar o painel. |
dashboard.url |
String | O URL relativo do painel (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.options |
Objeto | As propriedades e os valores de layout do painel, componente do painel e elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set . |
look:ready
Este evento é criado quando uma aparência começa a carregar dados de consulta, independentemente de a consulta ser executada ou não.
type: "look:ready",
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
Atributo | Formato | Descrição |
---|---|---|
look.url |
String | O URL de visualização relativa (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look:run:start
Este evento é criado quando uma aparência começa a carregar dados de consulta e a consulta começa a ser executada.
type: "look:run:start",
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
Atributo | Formato | Descrição |
---|---|---|
look.url |
String | O URL de visualização relativa (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look:run:complete
Este evento é criado quando uma consulta termina de executar a consulta.
type: look:run:complete
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
Atributo | Formato | Descrição |
---|---|---|
look.url |
String | O URL de visualização relativa (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look:save:complete
Este evento é criado quando uma aparência é editada e salva. Este evento é criado quando um usuário realiza uma das seguintes tarefas:
- Clica no botão Editar para editar a aparência e depois em Salvar
- Salva um visual com a opção de menu Save > Save As...
- Move uma visualização de uma pasta para outra
Esse evento não será criado se a aparência estiver salva com a opção de menu Salvar > Para o painel existente ou Editar configurações.
type: look:save:complete
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
spaceId: 123
}
}
Atributo | Formato | Descrição |
---|---|---|
look.url |
String | O URL de visualização relativa (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look.spaceID |
Inteiro | O ID da pasta em que o Look está armazenado |
look:delete:complete
Esse evento é criado quando uma aparência é movida para a pasta Lixeira.
type: look:delete:complete
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
Atributo | Formato | Descrição |
---|---|---|
look.url |
String | O URL de visualização relativa (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
drillmenu:click
Esse evento é criado quando um usuário clica em um menu de detalhamento em um painel criado com o parâmetro link
do LookML. Por exemplo, o LookML a seguir cria um menu de detalhamento em que um usuário pode visualizar dados filtrados pela dimensão 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"
}
}
Quando o filtro state
é definido como Illinois
, o evento drillmenu:click
retorna o seguinte ao host do iframe:
type: "drillmenu:click",
label: "Filter by Illinois",
link_type: "url",
modal: false,
target: '_self',
url: "#filter::state=Illinois"
context: ' '
Atributo | Formato | Descrição |
---|---|---|
label |
String | O rótulo do link, como mostrado no menu de detalhamento |
link_type |
String | O tipo de objeto no destino do link |
modal |
Booleano | Se a caixa de diálogo de detalhamento será usada em vez da navegação no navegador |
target |
String | É _self se o destino do link substituirá o iframe atual, _blank se o destino do link abrir uma nova janela. |
url |
String | O URL do destino do link |
context |
String | Atributo interno usado por alguns tipos de visualizações |
Colocar o iframe em sandbox impedirá que os cliques no menu de detalhamento sejam abertos em uma nova janela. Use estes valores de sandbox dentro da tag iframe:
sandbox = "allow-same-origin allow-scripts"
drillmodal:download
Este evento é criado quando um usuário abre uma caixa de diálogo de detalhamento em um bloco do painel e clica na opção Download.
{
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 | Descrição |
---|---|---|
dashboard.id |
Número/string | O ID do painel ao qual o bloco pertence. |
dashboard.title |
String | O título do painel, como mostrado na parte superior do painel ao qual o bloco pertence. |
dashboard.url |
String | O URL do painel relativo (apenas o caminho) ao qual o bloco pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel ao qual o bloco pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel ao qual o bloco pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
drillExploreUrl |
String | O URL relativo de exploração (apenas o caminho) a ser baixado. |
fileFormat |
String | O formato do arquivo de download dos dados. |
drillmodal:explore
Este evento é criado quando um usuário clica na opção Explorar a partir daqui em uma caixa de diálogo de detalhamento.
type: "drillmodal:explore",
label: "Explore From Here",
url: "/embed/explore/model/view..."
Atributo | Formato | Descrição |
---|---|---|
label |
String | O rótulo do botão, como mostrado no menu de detalhamento |
url |
String | O URL relativo de exploração (apenas o caminho) a ser visualizado |
explore:ready
Este evento é criado quando uma exploração começa a carregar dados de consulta, independentemente de a consulta ser executada ou não.
type: "explore:ready",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
}
}
Atributo | Formato | Descrição |
---|---|---|
explore.url |
String | O URL de exploração relativo (apenas o caminho) |
explore.absoluteUrl |
String | O URL completo da guia "Explorar" |
explore:run:start
Este evento é criado quando uma exploração começa a carregar dados de consulta e a consulta começa a ser executada.
type: "explore:run:start",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
}
}
Atributo | Formato | Descrição |
---|---|---|
explore.url |
String | O URL de exploração relativo (apenas o caminho) |
explore.absoluteUrl |
String | O URL completo da guia "Explorar" |
explore:run:complete
Este evento é criado quando a exploração termina de executar a consulta.
type: "explore:run:complete",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
}
}
Atributo | Formato | Descrição |
---|---|---|
explore.url |
String | O URL de exploração relativo (apenas o caminho) |
explore.absoluteUrl |
String | O URL completo da guia "Explorar" |
explore:state:changed
Este evento é criado quando o URL de uma página "Explorar" muda como resultado das ações do usuário.
type: "explore:state:changed",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/..."
}
Atributo | Formato | Descrição |
---|---|---|
explore.url |
String | O URL de exploração relativo (apenas o caminho) |
explore.absoluteUrl |
String | O URL completo da guia "Explorar" |
page:changed
Este evento é criado quando um usuário navega para uma nova página dentro do iframe.
type: "page:changed",
page: {
type: "dashboard",
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/..."
}
Atributo | Formato | Descrição |
---|---|---|
page.type |
String | O tipo de página que acabou de navegar, como "dashboard" , "look" ou "explore" |
page.url |
String | O URL relativo (apenas o caminho) da página para a qual acabou de ser navegado |
page.absoluteUrl |
String | O URL completo da página para a qual você acabou de navegar |
page:properties:changed
Este evento é criado quando a altura de um iframe do painel é alterada. Ela não está disponível para as aparências ou explorações porque os itens ajustam automaticamente a altura ao tamanho do iframe.
type: "page:properties:changed",
height: 1000
Atributo | Formato | Descrição |
---|---|---|
height |
Inteiro | A altura do iframe do painel em pixels |
session:tokens
Esse evento indica que o cliente do Looker precisa de tokens para continuar. Esse evento é criado imediatamente na criação do iframe e, depois, periodicamente, durante a sessão.
{
"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 | Descrição |
---|---|---|
authentication_token |
String | Token de autenticação. Incluído quando o iframe é criado. Não incluído com uma resposta para uma solicitação para gerar tokens ou se a sessão expirou. |
authentication_token_ttl |
Número | Tempo de vida útil do token de autenticação em segundos. Incluído quando o iframe é criado. Não incluído com uma resposta para uma solicitação para gerar tokens ou se a sessão expirou. |
api_token |
String | Token da API. Não incluído se a sessão expirou. |
api_token_ttl |
Número | Tempo de vida do token da API em segundos. Não incluído se a sessão expirou. |
navigation_token |
String | Token de navegação. Não incluído se a sessão expirou. |
navigation_token_ttl |
Número | Vida útil do token de navegação em segundos. Não incluído se a sessão expirou. |
session_references_token_ttl |
Número | Time to live da sessão em segundos. O valor será 0 quando a sessão tiver expirado. Para recuperar, o aplicativo de incorporação deve adquirir uma nova sessão. |
session:status
O evento é gerado quando o aplicativo Looker incorporado processa solicitações de tokens de sessão.
{
"type": "session:status",
"session_ttl": 0,
"expired": true,
"interrupted": false
}
Atributo | Formato | Descrição |
---|---|---|
session_ttl |
Número | Time to live da sessão em segundos. |
expired |
Booleano | Quando true , indica que a sessão expirou. |
interrupted |
Booleano | Quando true , indica que uma solicitação de tokens de sessão não foi respondida. Isso pode indicar que um servidor está temporariamente indisponível. |
recoverable |
Booleano | Preenchido apenas quando interrompido é true . Indica se a sessão pode ou não ser recuperada. Um valor false provavelmente significa que há um problema com o aplicativo de incorporação. |
env:client:dialog
O evento é gerado quando uma caixa de diálogo é aberta e pode não estar totalmente visível, como uma caixa de diálogo de detalhamento. Esse evento permite que o app de hospedagem role a caixa de diálogo para ver a ação env:host:scroll
.
{
type: "env:client:dialog",
dialogType: 'drilling',
placement: 'cover',
open: true
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | env:client:dialog indica que uma caixa de diálogo foi aberta ou fechada. Atualmente, apenas a caixa de diálogo de detalhamento é compatível, mas outras caixas de diálogo podem ser adicionadas no futuro. É possível que a parte superior da caixa de diálogo de detalhamento não esteja visível, pois a caixa de diálogo cobre a janela de visualização do iframe. Esse evento permite que o aplicativo host role a parte superior da caixa de diálogo para visualizá-lo. |
dialogType |
String | O tipo de caixa de diálogo. Atualmente, apenas a abertura ou o fechamento do tipo de caixa de diálogo "detalhamento" aciona esse evento. |
placement |
String | O posicionamento da caixa de diálogo. As caixas de diálogo do tipo "rilling" sempre usam um placement de "cover". |
open |
Booleano | Indica se a caixa de diálogo está aberta ou rolada. |
Como fazer alterações no iframe
Depois de preparar seu iframe para recuperação de dados, você pode fazer alterações ao iframe com as seguintes etapas:
Como escrever sua solicitação em JSON
É possível fazer várias alterações no iframe, que serão enviadas no formato JSON. As opções disponíveis são descritas na seção Referência da ação nesta página. Não se esqueça de usar JSON.stringify
para transformar sua ação em JSON, desta forma:
var my_request = JSON.stringify(
{
type: "dashboard:run"
}
);
Como postar a solicitação na propriedade contentWindow
do iframe
Por fim, poste sua mensagem no contentWindow
do iframe, assim:
var my_iframe = document.getElementById("my_iframe_id");
my_iframe.contentWindow.postMessage(my_request, 'https://instance_name.looker.com');
Tabela de resumo de ações
A tabela a seguir resume as ações. Clique em uma ação para ver os detalhes dela.
Ação | Descrição da ação |
---|---|
dashboard:load |
Carrega um novo painel no iframe, substituindo um painel existente. |
dashboard:run |
Executa o painel no iframe. |
dashboard:edit |
ADDED 22.20 Alterna o painel para o modo de edição. |
dashboard:filters:update |
Atualiza um filtro de painel existente no iframe. |
dashboard:options:set |
Grava novos valores no layout do painel e nas propriedades do elemento do painel. |
dashboard:schedule_modal:open |
Abre o programador, que permite que os usuários enviem conteúdo do Looker para vários destinos. |
dashboard:stop |
Interrompe um painel que está executando ou recarregando dados. |
look:run |
Executa a aparência no iframe. |
look:filters:update |
Atualiza um filtro de aparência existente no iframe. |
explore:run |
Executa a exploração no iframe. |
explore:filters:update |
Atualiza ou remove um filtro "Explorar" existente no iframe. |
session:tokens:request |
Envia tokens em resposta a um evento session:tokens:request . |
env:host:scroll |
Envia informações sobre a posição de rolagem atual do iframe do host para o aplicativo Looker incorporado. |
Referência da ação
Estas são as ações disponíveis que você pode postar no iframe incorporado:
dashboard:load
Use esta ação para carregar um novo painel no iframe, substituindo um painel existente. O novo painel começará a executar consultas como se uma nova página do painel tivesse sido aberta.
{
type: "dashboard:load",
id: "101",
pushHistory: false
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo dashboard:load indica que você quer carregar um novo painel no iframe. |
id |
String | O ID do painel a ser carregado. |
pushHistory |
Booleano | Se for true , o painel carregado criará uma nova entrada no histórico do navegador, e o usuário poderá usar o botão "botão "Voltar"" do navegador para retornar ao painel anterior. Se false , o painel atual é substituído, e a navegação do navegador não pode ser usada para retornar a ele. |
dashboard:run
Use esta ação para executar o painel no iframe. É o mesmo que clicar no botão Run ou Reload Data no painel.
{
type: "dashboard:run"
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo dashboard:run indica que você quer executar o painel. |
dashboard:edit
ADDED 22.20 Use esta ação para alternar um painel existente no iframe para o modo de edição. É a mesma ação que selecionar em Editar painel no menu do painel.
{
type: "dashboard:edit"
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo dashboard:edit indica que você quer alternar o painel para o modo de edição. |
dashboard:filters:update
Use esta ação para atualizar um filtro do painel no iframe. Não é possível adicionar um novo filtro ao painel usando esse método.
{
type: "dashboard:filters:update",
filters: {
"Sale date": "Last 28 days",
"Sale amount": "Greater than 100"
}
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo dashboard:filters:update indica que você quer atualizar os filtros usados pelo painel. |
filters |
Objeto | Os novos filtros que você deseja aplicar ao painel. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:options:set
Esta ação está disponível após o evento dashboard:run:complete
.
O incorporador cria a mensagem e a envia para o iframe, mas o painel não responde até que dashboard:run:complete
ocorra. A ação dashboard:options:set
grava novos valores no layout do painel e nas propriedades do elemento. Somente propriedades que foram retornadas no atributo options
do evento dashboard:run:complete
podem ser atualizadas usando dashboard:options:set
. Todas as propriedades definidas que não foram retornadas anteriormente pelo atributo options
do evento dashboard:run:complete
serão ignoradas.
{
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 | Descrição |
---|---|---|
type |
String | Usar o tipo dashboard:options:set indica que você quer gravar novos valores no layout e nas propriedades do elemento do painel. |
layouts |
Objeto | As propriedades do layout do painel retornadas pelo atributo options no evento dashboard:run:complete . Eles estarão em um formato semelhante a: id: "string", |
layouts.dashboard_layout_components |
Objeto | Um ou mais objetos de componente de layout do painel retornados pelo atributo options no evento dashboard:run:complete . Eles estarão em um formato semelhante a:id: "string", |
elements |
Objeto | Um ou mais objetos de elemento do painel retornados pelo atributo options no evento dashboard:run:complete . Eles estarão em um formato semelhante a:id: { |
dashboard:schedule_modal:open
Use essa ação para abrir o Scheduler, que permite que os usuários enviem conteúdo do Looker para vários destinos.
{
type: "dashboard:schedule_modal:open"
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo dashboard:schedule_modal:open indica que você quer abrir a caixa de diálogo Programar. |
dashboard:stop
Use esta ação para interromper um painel que está executando ou recarregando dados. É o mesmo que clicar no botão Cancelar no painel. Um painel que parou de usar dashboard:stop
envia um evento dashboard:run:complete
com status:
definido como "stopped"
.
{
type: "dashboard:stop"
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo dashboard:stop indica que você quer interromper o painel em execução. |
look:run
Use esta ação para executar a consulta na qual o Look está baseado no iframe. Isso é semelhante a pressionar o botão Run no Look, exceto pelo fato de que o look:run
sempre consulta o banco de dados diretamente e não recupera dados do cache do Looker.
{
type: "look:run"
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo look:run indica que você quer executar a aparência. |
look:filters:update
Use esta ação para atualizar um filtro de aparência existente no iframe. Não é possível adicionar um novo filtro à aparência usando esse método.
{
type: "look:filters:update",
filters: {
"orders.created_at": "90 days",
"products.department": "sweaters"
}
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo look:filters:update indica que você quer atualizar os filtros usados pelo Look. |
filters |
Objeto | Os novos filtros que você deseja aplicar à interface. Este objeto tem o formato: {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...} |
explore:run
Use esta ação para executar a exploração no iframe. Isso é semelhante a pressionar o botão Run em "Explorar", com a exceção de que explore:run
sempre consulta o banco de dados diretamente e não recupera dados do cache do Looker.
{
type: "explore:run"
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo explore:run indica que você quer executar a exploração. |
explore:filters:update
Use esta ação para atualizar ou remover um filtro "Explorar" existente no iframe. Incluir um novo filtro que faz referência a um campo válido adiciona o novo filtro à guia "Explorar".
{
type: "explore:filters:update",
filters: {
"orders.created_at": "90 days",
"orders.status": "complete"
}
deleteFilters: ["products.department"]
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo explore:filters:update indica que você quer atualizar os filtros usados pela ferramenta Explorar. |
filters |
Objeto | Os novos filtros que você deseja aplicar à guia "Explorar". Se filters incluir um filtro que não existe atualmente em "Explorar", mas que faz referência a um campo válido, esse filtro será adicionado a "Explorar". Este objeto tem o formato: {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...} |
deleteFilters |
Matriz | Os filtros existentes que você deseja remover da guia "Explorar". A matriz tem o formato: ["view_name.field_name_1", "view_name.field_name_2", ...] |
session:tokens:request
Use essa ação para enviar tokens em resposta a uma solicitação session:tokens:request
.
{
type: "session:tokens:request",
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo session:tokens:request indica que você quer enviar tokens em resposta a um evento session:tokens:request . |
env:host:scroll
Use esta ação para enviar informações sobre a posição de rolagem atual do iframe do host para o aplicativo Looker incorporado.
{
type: "env:host:scroll",
offsetTop: 10,
offsetLeft: 10,
scrollX: 5,
scrollY: 5
}
Atributo | Formato | Descrição |
---|---|---|
type |
String | Usar o tipo env:host:scroll indica que você quer enviar informações sobre a posição de rolagem atual do iframe do host para o aplicativo incorporado do Looker. |
offsetTop |
Número | O deslocamento superior do iframe. |
offsetLeft |
Número | O deslocamento à esquerda do iframe. |
scrollX |
Número | A posição rolagemX do host do aplicativo. |
scrollY |
Número | A posição ScrollY do host do aplicativo. |