Depois de criar uma incorporação, que pode ser feita publicamente, privadamente, com incorporação assinada ou através da API, pode interagir com esses iFrames através de JavaScript. Pode tornar a sua página mais dinâmica com base no estado do item incorporado e até fazer alterações ao item incorporado a partir da sua página Web.
Tenha em atenção que o Looker não controla a ordem em que os navegadores enviam eventos para aplicações Web. Isto significa que a ordem dos eventos não é garantida em todos os navegadores ou plataformas. Certifique-se de que escreve o JavaScript adequadamente para ter em conta o processamento de eventos de diferentes navegadores.
Pode usar JavaScript de uma das seguintes formas para conteúdo incorporado do Looker:
- Usar o SDK (Software Development Kit) de incorporação do Looker, descrito na página de documentação do SDK de incorporação
- Usando eventos JavaScript, descritos na secção Aceder a eventos em JavaScript nesta página
Preparação
Antes de poder interagir com o iFrame incorporado, siga estes passos:
- Adicione um ID ao iFrame.
- Adicione o domínio de incorporação ao atributo
srcdo iFrame. - Adicione o domínio de incorporação à lista de autorizações.
Adicionar um ID ao iFrame
Mais tarde, quando extrair dados do iFrame, tem de validar se as informações com que está a trabalhar provêm efetivamente do iFrame do Looker. Para facilitar este processo, certifique-se de que adiciona um ID ao seu iFrame, se ainda não o tiver feito. No exemplo seguinte, define o ID como looker adicionando id="looker" ao iFrame:
<iframe id="looker" src="https://instance_name.looker.com/embed/dashboards/1"></iframe>
Adicionar o domínio de incorporação ao atributo src do iFrame
No atributo src do iFrame, inclua o domínio onde o iFrame está a ser usado. No exemplo seguinte, pode especificar myownpersonaldomain.com como o domínio adicionando ?embed_domain=https://myownpersonaldomain.com" ao final do URL no atributo src:
<iframe
id="looker"
src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com">
</iframe>
Se estiver a usar a incorporação com assinatura, certifique-se de que adiciona o parâmetro embed_domain ao URL de incorporação.
Se estiver a usar o SDK de incorporação, adicione sdk=3 ao final do URL de incorporação. O parâmetro sdk=3 indica que o SDK está presente e que o Looker pode tirar partido de funcionalidades adicionais que o SDK oferece, como a transmissão de eventos JavaScript entre o iFrame do Looker e o seu domínio. O SDK não pode adicionar este parâmetro por si só porque faz parte do URL assinado. Por exemplo:
<iframe
id="looker"
src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com&sdk=2">
</iframe>
Adicionar o domínio de incorporação à lista de autorizações
Por último, tem de adicionar o domínio onde o iFrame está a ser usado à lista de autorizações na página Incorporar do painel de administração do Looker seguindo estes passos:
No campo Lista de autorizações de domínios incorporados, introduza o domínio onde o iFrame está a ser usado e, de seguida, prima a tecla Tab para que o domínio apareça numa caixa dentro do campo.
Clique em Atualizar.
Pode usar o caráter universal * na lista de autorizações para criar um padrão de domínio. Por exemplo, https://*.myownpersonaldomain.com permitiria https://analytics.myownpersonaldomain.com e https://data.myownpersonaldomain.com.
Se estiver a usar a incorporação sem cookies com o Looker 23.8 ou posterior, o domínio de incorporação pode ser especificado quando a sessão sem cookies é adquirida. Esta é uma alternativa à adição do domínio de incorporação à lista de autorizações através do painel Administração > Incorporar. Reveja as práticas recomendadas de segurança se decidir tirar partido desta funcionalidade.
A obter dados do iFrame
Após concluir os passos de preparação, pode aceder aos eventos transmitidos entre o iFrame do Looker e o seu domínio ao ouvir os eventos postMessage.
O iFrame incorporado pode criar alguns tipos de eventos, conforme descrito na secção Referência do tipo de evento nesta página.
Aceder a eventos em JavaScript
Segue-se um exemplo de como ouvir estes eventos em JavaScript e, em seguida, registar os eventos na 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));
}
}
});
Segue-se um exemplo de como ouvir estes eventos no jQuery e, em seguida, registá-los na 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));
}
}
});
Tabela de resumo do tipo de evento
A tabela seguinte resume os tipos de eventos. Selecione um tipo de evento para ver os detalhes sobre esse evento.
| Tipo de evento | Causa do evento |
|---|---|
dashboard:loaded |
Nos painéis de controlo em que os mosaicos não estão definidos para execução automática, um painel de controlo e os respetivos elementos foram carregados, mas as consultas ainda não estão a ser executadas. |
dashboard:run:start |
Um painel de controlo começou a ser carregado e os respetivos mosaicos começaram a ser carregados e a consultar dados. |
dashboard:run:complete |
Um painel de controlo terminou a execução e todos os mosaicos terminaram o carregamento e a consulta. |
dashboard:download |
A transferência de um PDF de um painel de controlo foi iniciada. |
dashboard:edit:start |
Adicionado 22,20
Um painel de controlo foi mudado para o modo de edição. O evento dashboard:save:complete é acionado quando o painel de controlo é guardado com êxito. |
dashboard:edit:cancel |
Adicionado 22,20 € Foi terminado o modo de edição de um painel de controlo sem guardar. |
dashboard:save:complete |
Um painel de controlo foi editado e guardado. |
dashboard:delete:complete |
Um painel de controlo foi eliminado. |
dashboard:tile:start |
Um mosaico começou a carregar ou a consultar dados. |
dashboard:tile:complete |
Um mosaico terminou a execução da consulta. |
dashboard:tile:download |
Os dados de um mosaico começaram a ser transferidos. |
dashboard:tile:explore |
Um utilizador clicou na opção Explorar a partir daqui num mosaico do painel de controlo. |
dashboard:tile:merge |
Adicionado 25,14 Um utilizador clicou no botão ou no item de menu Editar consulta unida. |
dashboard:tile:view |
Um utilizador clicou na opção Ver aspeto original num mosaico do painel de controlo. |
dashboard:filters:changed |
Os filtros de um painel de controlo foram aplicados ou alterados. |
look:ready |
Um Look começou a carregar dados de consultas, independentemente de a consulta ser executada ou não. |
look:run:start |
Um Look começou a carregar dados de consultas e a consulta começou a ser executada. |
look:run:complete |
Um Look terminou a execução da consulta. |
look:edit:start |
Adicionado a 25/10
Um visual foi mudado para o modo de edição. O evento look:save:complete é acionado quando o visual é guardado. |
look:edit:cancel |
Adicionado a 25/10 Saiu do modo de edição de um visual sem guardar. |
look:save:complete |
Um Look foi editado e guardado. |
look:delete:complete |
Um Look foi movido para a pasta Lixo. |
drillmenu:click |
Um utilizador clicou num menu de detalhe num painel de controlo criado com o link parâmetro LookML. |
drillmodal:download |
Um utilizador abriu uma caixa de diálogo de detalhe a partir de um mosaico do painel de controlo e clicou na opção Transferir. |
drillmodal:explore |
Um utilizador clicou na opção Explorar a partir daqui numa caixa de diálogo de detalhe. |
explore:ready |
Uma exploração começou a carregar dados de consulta, independentemente de a consulta ser executada ou não. |
explore:run:start |
Uma exploração começou a carregar dados de consultas e a consulta começou a ser executada. |
explore:run:complete |
Uma análise detalhada terminou de executar a consulta. |
explore:state:changed |
O URL de uma página Explorar foi alterado como resultado das ações do utilizador. |
page:changed |
Um utilizador navegou para uma nova página no iFrame. |
page:properties:changed |
A altura de um iFrame do painel de controlo foi alterada. |
session:tokens |
O cliente do Looker requer tokens para continuar. |
session:expired |
Adicionado a 25/10 A sessão do utilizador expirou. |
session:status |
Envia informações sobre o estado de uma sessão. |
env:client:dialog |
Foi aberta uma caixa de diálogo que pode estar parcialmente fora da vista, como uma caixa de diálogo de detalhe. Este evento permite que a aplicação de alojamento desloque a caixa de diálogo para a vista. |
Referência do tipo de evento
O iFrame incorporado pode criar muitos tipos diferentes de eventos:
dashboard:loaded
Nos painéis de controlo em que os mosaicos não estão definidos para execução automática, este evento é criado depois de um painel de controlo e os respetivos elementos terem sido carregados, mas antes de as consultas serem executadas.
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 de controlo e os respetivos elementos foram carregados com êxito. |
dashboard.id |
Número/string | O ID do painel de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.options |
Objeto | As propriedades e os valores do esquema do painel de controlo, do componente do esquema do painel de controlo e do elemento do painel de controlo. Todas as propriedades devolvidas no objeto options podem receber valores atualizados através do evento dashboard:options:set. |
dashboard:run:start
Este evento é criado quando um painel de controlo começa a ser carregado, quando os respetivos mosaicos começam a ser carregados e a 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 de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:run:complete
Este evento é criado quando um painel de controlo termina a execução e todos os mosaicos terminam o carregamento e a consulta. Este evento é criado independentemente de todos os mosaicos serem carregados com êxito 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 de controlo e os respetivos elementos foram executados com êxito. Se o painel de controlo e os respetivos elementos tiverem sido executados com êxito, status devolve "complete"; caso contrário, status devolve "error". Se o painel de controlo em execução tiver sido parado, quer através da interface do utilizador, quer com a ação dashboard:stop, status devolve "stopped". |
dashboard.id |
Número/string | O ID do painel de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.options |
Objeto | As propriedades e os valores do esquema do painel de controlo, do componente do esquema do painel de controlo e do elemento do painel de controlo. Todas as propriedades devolvidas no objeto options podem receber valores atualizados através da ação dashboard:options:set. |
dashboard.tileStatuses |
Matriz de objetos | Uma matriz de objetos que fornecem os estados dos mosaicos. As propriedades do objeto são:
|
dashboard:download
Este evento é criado quando a transferência de um PDF de um painel de controlo é iniciada.
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 de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
fileFormat |
String | O formato do painel de controlo transferido (apenas "pdf" neste momento). |
dashboard:edit:start
Adicionado a 22.20 Este evento é criado quando um painel de controlo é ativado no 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 de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:edit:cancel
Adicionado a 22.20 Este evento é criado quando se sai do modo de edição de um painel de controlo sem guardar.
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 de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:save:complete
Este evento é criado quando um painel de controlo é editado e, em seguida, guardado.
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 de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.options |
Objeto | As propriedades e os valores do esquema do painel de controlo, do componente do esquema do painel de controlo e do elemento do painel de controlo. Todas as propriedades devolvidas no objeto options podem receber valores atualizados através do evento dashboard:options:set. |
dashboard:delete:complete
Este evento é criado quando um painel de controlo é eliminado.
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 de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.options |
Objeto | As propriedades e os valores do esquema do painel de controlo, do componente do esquema do painel de controlo e do elemento do painel de controlo. Todas as propriedades devolvidas no objeto options podem receber valores atualizados através do evento dashboard:options:set. |
dashboard:tile:start
Este evento é criado quando um mosaico começa a carregar ou a 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 de controlo ao qual o mosaico pertence. |
dashboard.title |
String | O título do painel de controlo, conforme apresentado na parte superior do painel de controlo ao qual o mosaico pertence. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho) ao qual o mosaico pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo ao qual o mosaico pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo ao qual o mosaico pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Número inteiro | O número de ID do evento e não do mosaico. |
tile.title |
String | O título do mosaico, conforme apresentado na parte superior do mosaico. |
tile.listen |
Objeto | Os filtros do painel de controlo global que este mosaico está a detetar. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
dashboard:tile:complete
Este evento é criado quando um mosaico 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 de controlo ao qual o mosaico pertence. |
dashboard.title |
String | O título do painel de controlo, conforme apresentado na parte superior do painel de controlo ao qual o mosaico pertence. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho) ao qual o mosaico pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo ao qual o mosaico pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo ao qual o mosaico pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
status |
String | Se a consulta de mosaicos foi concluída com êxito. Os valores possíveis são "complete" ou "error". |
truncated |
Booleano | Se os resultados da consulta do mosaico foram truncados porque a consulta devolveu mais linhas do que o limite de linhas da consulta. O limite de linhas pode ser um limite de linhas especificado pelo utilizador ou o limite de linhas predefinido do Looker de 5000. |
tile.id |
Número inteiro | O número de ID do evento e não do mosaico. |
tile.title |
String | O título do mosaico, conforme apresentado na parte superior do mosaico. |
tile.listen |
Objeto | Os filtros do painel de controlo global que este mosaico está a detetar. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
tile.errors |
Matriz de objetos | Preenchido quando a propriedade status é "error". Uma matriz de objetos que fornece detalhes do erro, incluindo o texto da mensagem de erro, uma descrição mais detalhada do erro e a consulta SQL do mosaico que produziu o erro. |
dashboard:tile:download
Este evento é criado quando os dados de um mosaico começam a ser transferidos.
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 de controlo ao qual o mosaico pertence. |
dashboard.title |
String | O título do painel de controlo, conforme apresentado na parte superior do painel de controlo ao qual o mosaico pertence. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho) ao qual o mosaico pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo ao qual o mosaico pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo ao qual o mosaico pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Número inteiro | O número de ID do evento e não do mosaico. |
tile.title |
String | O título do mosaico, conforme apresentado na parte superior do mosaico. |
tile.listen |
Objeto | Os filtros do painel de controlo global que este mosaico está a detetar. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
fileFormat |
String | O formato do mosaico transferido (apenas "pdf" neste momento). |
dashboard:tile:explore
Este evento é criado quando um utilizador clica na opção Explorar a partir daqui num mosaico do painel de controlo.
Este evento é cancelável, o que significa que a aplicação de incorporação pode devolver {cancel: true} e o Looker não prossegue com o evento de acionamento.
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 | A etiqueta do botão. |
url |
String | O URL relativo (apenas o caminho) da exploração a ser vista. |
dashboard.id |
Número/string | O ID do painel de controlo ao qual o mosaico pertence. |
dashboard.title |
String | O título do painel de controlo, conforme apresentado na parte superior do painel de controlo ao qual o mosaico pertence. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho) ao qual o mosaico pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo ao qual o mosaico pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo ao qual o mosaico pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Número inteiro | O número de ID do evento e não do mosaico. |
tile.title |
String | O título do mosaico, conforme apresentado na parte superior do mosaico. |
tile.listen |
Objeto | Os filtros do painel de controlo global que este mosaico está a detetar. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
dashboard:tile:view
Este evento é criado quando um utilizador clica na opção Ver visual original num mosaico do painel de controlo.
Este evento é cancelável, o que significa que a aplicação de incorporação pode devolver {cancel: true} e o Looker não prossegue com o evento de acionamento.
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 | A etiqueta do botão. |
url |
String | O URL relativo (apenas o caminho) da análise detalhada a ser vista. |
dashboard.id |
Número/string | O ID do painel de controlo ao qual o mosaico pertence. |
dashboard.title |
String | O título do painel de controlo, conforme apresentado na parte superior do painel de controlo ao qual o mosaico pertence. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho) ao qual o mosaico pertence. |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo ao qual o mosaico pertence. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo ao qual o mosaico pertence. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
Número inteiro | O número de ID do evento e não do mosaico. |
tile.title |
String | O título do mosaico, conforme apresentado na parte superior do mosaico. |
tile.listen |
Objeto | Os filtros do painel de controlo global que este mosaico está a detetar. Este objeto tem o formato: {"Filter Label": "Filter Field", ...} |
dashboard:tile:merge
Added 25.14 Este evento é gerado quando o utilizador clica no botão Editar consulta unida ou no item de menu Editar consulta unida. O comportamento predefinido deste botão é abrir uma nova janela de nível superior que permite editar a consulta de união.
Este evento é cancelável, o que significa que a aplicação de incorporação pode devolver {cancel: true} e o Looker não prossegue com o evento de acionamento. Este evento permite que a aplicação de incorporação abra a edição da consulta de união num iFrame em vez de numa janela de nível superior. A aplicação de incorporação não deve tentar carregar o URL no iFrame que acionou o evento. Em alternativa, deve criar um novo iFrame.
javascript
type: dashboard:tile:merge,
label: 'Edit Merged Query',
dashboard_id: '13',
dashboard_modified: false,
tile_id: '218',
tile_title: 'Untitled',
url: '/embed/merge/edit?did=218&dbnx=1',
absoluteUrl: 'https://.../embed/merge/edit?did=218&dbnx=1',
target: '_blank',
| Atributo | Formato | Descrição |
|---|---|---|
label |
de string | A etiqueta do botão. |
dashboard_id |
de string | O ID do painel de controlo ao qual o mosaico de consulta unida pertence. |
dashboard_modified |
booleano | Quando true, este atributo indica que o painel de controlo foi modificado. As atualizações ao painel de controlo podem ser perdidas se a edição da consulta de união prosseguir. A aplicação de incorporação pode cancelar a edição da consulta de união ou avisar o utilizador de que pode ter alterações não guardadas se continuar. |
tile_id |
de string | O ID do mosaico de consulta unida. |
tile_title |
de string | O título do mosaico. |
url |
de string | O URL da consulta unida. Este atributo pode ser usado com o SDK incorporado para criar um novo iFrame para a consulta unida. |
absoluteUrl |
de string | O URL completo da consulta unida. Este atributo pode ser usado como o src do elemento iframe. São necessários atributos adicionais. |
target |
de string | O ID a usar para o nome da janela a abrir. |
dashboard:filters:changed
Este evento é criado quando os filtros de um painel de controlo 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 de controlo. |
dashboard.title |
String | O título, conforme apresentado na parte superior do painel de controlo. |
dashboard.canEdit |
Booleano |
Adicionado a 22.20
Quando true, o utilizador pode editar o painel de controlo. |
dashboard.url |
String | O URL do painel de controlo relativo (apenas o caminho). |
dashboard.absoluteUrl |
String | O URL completo do painel de controlo. |
dashboard.dashboard_filters |
Objeto | Os filtros aplicados ao painel de controlo. Este objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.options |
Objeto | As propriedades e os valores do esquema do painel de controlo, do componente do esquema do painel de controlo e do elemento do painel de controlo. Todas as propriedades devolvidas no objeto options podem receber valores atualizados através do evento dashboard:options:set. |
look:ready
Este evento é criado quando um Look começa a carregar dados de consultas, quer a consulta seja 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 do Look relativo (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look:run:start
Este evento é criado quando uma análise detalhada 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 do Look relativo (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look:run:complete
Este evento é criado quando um Look termina a execução da 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 do Look relativo (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look:edit:start
Adicionado a 25/10 Este evento é acionado quando um Look é mudado para o modo de edição.
type: "look:edit:start",
look: {
id: 46,
title: "My Look",
url: "/embed/looks/46",
absoluteUrl: "https://instance_name.looker.com/embed/looks/46",
}
| Atributo | Formato | Descrição |
|---|---|---|
look.id |
String | O ID do Look. |
look.title |
String | O título do Look. |
url |
String | O URL de visualização relativo (apenas o caminho). |
absoluteUrl |
String | O URL completo do Look. |
look:edit:cancel
Adicionado a 25/10 Este evento é acionado quando um aspeto que está no modo de edição sai do modo de edição sem guardar.
type: "look:edit:cancel",
look: {
id: 46,
title: "My Look",
url: "/embed/looks/46",
absoluteUrl: "https://instance_name.looker.com/embed/looks/46",
}
| Atributo | Formato | Descrição |
|---|---|---|
look.id |
String | O ID do Look. |
look.title |
String | O título do Look. |
url |
String | O URL de visualização relativo (apenas o caminho). |
absoluteUrl |
String | O URL completo do Look. |
look:save:complete
Este evento é criado quando um visual é editado e guardado. Este evento é criado quando um utilizador realiza uma das seguintes tarefas:
- Clica no botão Editar para editar o aspeto e, de seguida, clica em Guardar
- Guarda um visual com a opção de menu Guardar > Guardar como…
- Move um visual de uma pasta para outra
Este evento não é criado se o relatório detalhado for guardado com a opção de menu Guardar > No painel de controlo existente ou Editar definições.
type: look:save:complete
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
folderid: 123
}
| Atributo | Formato | Descrição |
|---|---|---|
look.url |
String | O URL do Look relativo (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
look.folderid |
Número inteiro | O ID da pasta onde o Look está armazenado |
look:delete:complete
Este evento é criado quando um Look é movido para a pasta Lixo.
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 do Look relativo (apenas o caminho) |
look.absoluteUrl |
String | O URL completo do Look |
drillmenu:click
Este evento é criado quando um utilizador clica num menu de detalhe num painel de controlo criado com o link parâmetro LookML. Por exemplo, o seguinte LookML cria um menu de detalhe no qual um utilizador pode ver 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 está definido como Illinois, o evento drillmenu:click devolve o seguinte ao anfitrião do iFrame:
type: "drillmenu:click",
label: "Filter by Illinois",
link_type: "url",
modal: false,
target: '_self',
url: "#filter::state=Illinois"
context: ' '
Este evento é cancelável, o que significa que a aplicação de incorporação pode devolver {cancel: true} e o Looker não prossegue com o evento de acionamento.
| Atributo | Formato | Descrição |
|---|---|---|
label |
String | A etiqueta do link, conforme apresentado no menu de detalhe |
link_type |
String | O tipo de objeto no destino do link |