Eventos JavaScript incorporados

Depois de criar uma incorporação, que pode ser feita publicamente, privadamente, com incorporação assinada ou pela API, é possível interagir com esses iframes usando JavaScript. Você pode tornar sua página mais dinâmica com base no status do item incorporado e até mesmo fazer mudanças nele na 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 diferentes navegadores ou plataformas. Escreva seu JavaScript de maneira adequada para considerar o processamento de eventos de diferentes navegadores.

Você pode usar JavaScript de uma das seguintes maneiras para conteúdo incorporado do Looker:

Preparação

Antes de interagir com o iframe incorporado, siga estas etapas:

Adicionar um ID ao iframe

Depois, ao recuperar dados do iframe, você precisará validar se as informações com que está trabalhando realmente vieram do iframe do Looker. Para facilitar isso, adicione um ID ao iframe, se ainda não tiver feito isso. No exemplo a seguir, você define o ID como looker ao adicionar 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 em que ele está sendo usado. No exemplo a seguir, você 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 você estiver usando a incorporação assinada, adicione o embed_domain ao URL de incorporação.

Se você estiver usando 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 aproveitar outros recursos fornecidos por ele, como a transmissão de eventos JavaScript entre o iframe do Looker e seu domínio. O SDK não pode adicionar esse parâmetro por conta própria porque ele faz parte do URL assinado. 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 permissões

Por fim, adicione o domínio em que o iframe está sendo usado à lista de permissões na página Incorporar do painel Administrador do Looker seguindo estas etapas:

  1. No campo Lista de permissões de domínio incorporado, insira o domínio em que o iframe está sendo usado e pressione a tecla Tab para que o domínio apareça em uma caixa dentro do campo.

  2. Clique em Atualizar.

Você pode usar o caractere curinga * na lista de permissõ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 você estiver usando incorporação sem cookies com o Looker 23.8 ou uma versão mais recente, o domínio de incorporação poderá ser especificado quando a sessão sem cookies for adquirida. Essa é uma alternativa a adicionar o domínio de incorporação à lista de permissões usando o painel Administrador > Incorporar. Consulte as práticas recomendadas de segurança se decidir usar esse recurso.

Recuperar dados do iframe

Depois de concluir as etapas de preparação, acesse os eventos transmitidos entre o iframe do Looker e seu domínio detectando eventos postMessage.

O iframe incorporado pode criar alguns tipos de eventos, conforme descrito na seção Referência de tipo de evento desta página.

Como acessar eventos em JavaScript

Confira um exemplo de como detectar esses eventos em JavaScript e depois registrar os eventos 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));
    }
  }
});

Confira um exemplo de como detectar esses eventos no jQuery e 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 eventos. Selecione um tipo de evento para ver os detalhes dele.

Tipo de evento Causa do evento
dashboard:loaded Nos painéis em que os blocos não estão definidos para execução automática, um painel e os elementos dele foram carregados, mas as consultas ainda não estão em execução.
dashboard:run:start Um painel começou a ser carregado, e os blocos dele também começaram a carregar e consultar dados.
dashboard:run:complete Um painel terminou de ser executado, e todos os blocos foram carregados e consultados.
dashboard:download O download de um PDF de um painel começou.
dashboard:edit:start Adicionado 22.20 Um painel foi mudado para o modo de edição. O evento dashboard:save:complete será acionado quando o painel for salvo.
dashboard:edit:cancel Adicionado 22.20 Um painel no modo de edição foi fechado 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 Os dados de um bloco começaram a ser baixados.
dashboard:tile:explore Um usuário clicou na opção Analisar 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 mudados.
look:ready Um Look começou a carregar dados de consulta, independentemente de a consulta ser executada ou não.
look:run:start Um Look começou a carregar dados de consulta, e a consulta começou a ser executada.
look:run:complete Um Look terminou de executar a consulta.
look:edit:start Adicionado em 25.10 Uma análise detalhada foi alternada para o modo de edição. O evento look:save:complete será disparado quando o look for salvo.
look:edit:cancel Adicionado na versão 25.10 Uma análise no modo de edição foi fechada sem ser salva.
look:save:complete Um Look 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 Fazer o download.
drillmodal:explore Um usuário clicou na opção Explorar daqui em uma caixa de diálogo de detalhamento.
explore:ready Uma análise começou a carregar dados de consulta, seja ela executada ou não.
explore:run:start Uma análise começou a carregar dados de consulta, 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 usuário.
page:changed Um usuário navegou até 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:expired Adicionado em 25/10 A sessão do usuário expirou.
session:status Envia informações sobre o status de uma sessão.
env:client:dialog Uma caixa de diálogo foi aberta e pode estar parcialmente fora da visualização, como uma caixa de diálogo de detalhamento. Esse evento permite que o aplicativo de hospedagem role a caixa de diálogo para que ela apareça.

Referência do tipo de evento

O iframe incorporado pode criar vários tipos diferentes de eventos:

dashboard:loaded

Em painéis em que os blocos não estão definidos para execução automática, esse evento é criado depois que um painel e os elementos dele são carregados, mas antes que as consultas sejam 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 e os elementos dele foram carregados corretamente.
dashboard.id Número/string O ID do painel.
dashboard.title String O título, conforme mostrado na parte de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel. Esse 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 do layout do painel, do componente de layout do painel e do elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set.

dashboard:run:start

Esse evento é criado quando um painel começa a ser carregado e quando os blocos dele começam a ser carregados e consultados para 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 de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 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. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:run:complete

Esse evento é criado quando um painel termina de ser executado e todos os blocos terminam de carregar e consultar. Esse 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 os elementos dele foram executados com sucesso. Se o painel e os elementos dele forem executados corretamente, status vai retornar "complete". Caso contrário, status vai 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 de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 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. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objeto As propriedades e os valores do layout do painel, do componente de layout do painel e do 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 que fornecem status de bloco. As propriedades do objeto são:

  • tileId: o número de ID do bloco.
  • status: se a consulta de bloco for executada com êxito, status vai retornar "complete". Caso contrário, status vai retornar "error".
  • errors: preenchido quando a propriedade status é "error". Uma matriz de objetos que fornecem detalhes do erro, incluindo o texto da mensagem de erro, uma descrição mais detalhada do erro e a consulta SQL do bloco que produziu o erro.

dashboard:download

Esse evento é criado quando o download de um PDF de um painel começa.

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 de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 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. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
fileFormat String O formato do painel baixado (somente "pdf" no momento).

dashboard:edit:start

Adicionado 22.20 Esse evento é criado quando um painel é colocado 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.
dashboard.title String O título, conforme mostrado na parte de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 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. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:edit:cancel

Adicionado na versão 22.20 Esse evento é criado quando um painel no modo de edição é fechado 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 de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 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. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:save:complete

Esse 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 de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel. Esse 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 do layout do painel, do componente de layout do painel e do elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set.

dashboard:delete:complete

Esse 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 de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel. Esse 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 do layout do painel, do componente de layout do painel e do elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set.

dashboard:tile:start

Esse 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 a que o bloco pertence.
dashboard.title String O título do painel, conforme mostrado na parte superior do painel a que o bloco pertence.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.url String O URL relativo do painel (apenas o caminho) a que o bloco pertence.
dashboard.absoluteUrl String O URL completo do painel a que o bloco pertence.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel a que o bloco pertence. Esse 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, não do bloco.
tile.title String O título do bloco, conforme mostrado na parte de cima dele.
tile.listen Objeto Os filtros do painel global que este bloco está detectando. Esse objeto tem o formato: {"Filter Label": "Filter Field", ...}

dashboard:tile:complete

Esse 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 a que o bloco pertence.
dashboard.title String O título do painel, conforme mostrado na parte superior do painel a que o bloco pertence.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.url String O URL relativo do painel (apenas o caminho) a que o bloco pertence.
dashboard.absoluteUrl String O URL completo do painel a que o bloco pertence.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel a que o bloco pertence. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
status String Indica se a consulta de bloco foi concluída. Os valores possíveis são "complete" ou "error".
truncated Booleano Se os resultados da consulta de bloco foram truncados porque a consulta retornou mais linhas do que o limite de linhas da consulta. O limite de linhas pode ser especificado pelo usuário ou o limite padrão do Looker de 5.000 linhas.
tile.id Número inteiro O número de ID do evento, não do bloco.
tile.title String O título do bloco, conforme mostrado na parte de cima dele.
tile.listen Objeto Os filtros do painel global que este bloco está detectando. Esse objeto tem o formato: {"Filter Label": "Filter Field", ...}
tile.errors Matriz de objetos Preenchido quando a propriedade status é "error". Uma matriz de objetos que fornecem detalhes do erro, incluindo o texto da mensagem de erro, uma descrição mais detalhada do erro e a consulta SQL do bloco que produziu o erro.

dashboard:tile:download

Esse 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 a que o bloco pertence.
dashboard.title String O título do painel, conforme mostrado na parte superior do painel a que o bloco pertence.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.url String O URL relativo do painel (apenas o caminho) a que o bloco pertence.
dashboard.absoluteUrl String O URL completo do painel a que o bloco pertence.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel a que o bloco pertence. Esse 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, não do bloco.
tile.title String O título do bloco, conforme mostrado na parte de cima dele.
tile.listen Objeto Os filtros do painel global que este bloco está detectando. Esse objeto tem o formato: {"Filter Label": "Filter Field", ...}
fileFormat String O formato do bloco baixado (somente "pdf" no momento).

dashboard:tile:explore

Esse evento é criado quando um usuário clica na opção Analisar 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 Análise a ser visualizada.
dashboard.id Número/string O ID do painel a que o bloco pertence.
dashboard.title String O título do painel, conforme mostrado na parte superior do painel a que o bloco pertence.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.url String O URL relativo do painel (apenas o caminho) a que o bloco pertence.
dashboard.absoluteUrl String O URL completo do painel a que o bloco pertence.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel a que o bloco pertence. Esse 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, não do bloco.
tile.title String O título do bloco, conforme mostrado na parte de cima dele.
tile.listen Objeto Os filtros do painel global que este bloco está detectando. Esse objeto tem o formato: {"Filter Label": "Filter Field", ...}

dashboard:tile:view

Esse 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 análise detalhada a ser visualizada.
dashboard.id Número/string O ID do painel a que o bloco pertence.
dashboard.title String O título do painel, conforme mostrado na parte superior do painel a que o bloco pertence.
dashboard.canEdit Booleano Adicionado na versão 22.20 Quando true, o usuário pode editar o painel.
dashboard.url String O URL relativo do painel (apenas o caminho) a que o bloco pertence.
dashboard.absoluteUrl String O URL completo do painel a que o bloco pertence.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel a que o bloco pertence. Esse 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, não do bloco.
tile.title String O título do bloco, conforme mostrado na parte de cima dele.
tile.listen Objeto Os filtros do painel global que este bloco está detectando. Esse objeto tem o formato: {"Filter Label": "Filter Field", ...}

dashboard:filters:changed

Esse evento é criado quando os filtros de um painel são aplicados ou mudados.

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 de cima do painel.
dashboard.canEdit Booleano Adicionado na versão 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. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objeto As propriedades e os valores do layout do painel, do componente de layout do painel e do elemento do painel. Todas as propriedades retornadas no objeto options podem receber valores atualizados usando o evento dashboard:options:set.

look:ready

Esse evento é criado quando um Look começa a carregar dados de consulta, seja ela 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 relativo do look (apenas o caminho)
look.absoluteUrl String O URL completo do Look

look:run:start

Esse evento é criado quando um Look 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 relativo do look (apenas o caminho)
look.absoluteUrl String O URL completo do Look

look:run:complete

Esse evento é criado quando um Look 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 relativo do look (apenas o caminho)
look.absoluteUrl String O URL completo do Look

look:edit:start

Adicionado na versão 25.10 Esse evento é disparado quando um Look é alternado 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 da análise detalhada.
look.title String O título do Look.
url String O URL relativo do olhar (apenas o caminho).
absoluteUrl String O URL completo do Look.

look:edit:cancel

Adicionado na versão 25.10 Esse evento é disparado quando uma análise no modo de edição é fechada sem ser salva.

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 da análise detalhada.
look.title String O título do Look.
url String O URL relativo do olhar (apenas o caminho).
absoluteUrl String O URL completo do Look.

look:save:complete

Esse evento é criado quando uma análise detalhada é editada e salva. Esse evento é criado quando um usuário realiza uma das seguintes tarefas:

Esse evento não é criado se o Look for salvo com a opção de menu Salvar > Em um painel ou Editar configuraçõ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 relativo do look (apenas o caminho)
look.absoluteUrl String O URL completo do Look
look.folderid Número inteiro O ID da pasta em que o Look está armazenado

look:delete:complete

Esse evento é criado quando um Look é movido 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 relativo do look (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 LookML link. Por exemplo, a LookML a seguir cria um menu de detalhamento em que um usuário 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 é definido como Illinois, o evento drillmenu:click retorna o seguinte para o 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, conforme mostrado no menu de detalhamento
link_type String O tipo de objeto no destino do link
modal Booleano Indica se a caixa de diálogo de detalhamento será usada em vez da navegação do navegador.
target String É _self se o destino do link substituir o iframe atual ou _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.

O isolamento em sandbox do iframe impede que os cliques no menu detalhado sejam abertos em uma nova janela. Use estes valores de isolamento em sandbox na tag iframe:

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

drillmodal:download

Esse evento é criado quando um usuário abre uma caixa de diálogo de detalhamento de um bloco do painel e clica na opção Fazer 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 a que o bloco pertence.
dashboard.title String O título do painel, conforme mostrado na parte superior do painel a que o bloco pertence.
dashboard.url String O URL relativo do painel (apenas o caminho) a que o bloco pertence.
dashboard.absoluteUrl String O URL completo do painel a que o bloco pertence.
dashboard.dashboard_filters Objeto Os filtros aplicados ao painel a que o bloco pertence. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
drillExploreUrl String O URL relativo do recurso "Explorar" (apenas o caminho) a ser baixado.
fileFormat String O formato do arquivo do download de dados.

drillmodal:explore

Esse evento é criado quando um usuário clica na opção Detalhar 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, conforme mostrado no menu de detalhamento
url String O URL relativo da Análise (apenas o caminho) a ser visualizado

explore:ready

Esse evento é criado quando uma análise detalhada começa a carregar dados de consulta, seja ela 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 relativo do recurso "Explorar" (apenas o caminho)
explore.absoluteUrl String O URL completo do recurso Detalhar

explore:run:start

Esse evento é criado quando uma análise detalhada 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 relativo do recurso "Explorar" (apenas o caminho)
explore.absoluteUrl String O URL completo do recurso Detalhar

explore:run:complete

Esse evento é criado quando uma análise detalhada 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 relativo do recurso "Explorar" (apenas o caminho)
explore.absoluteUrl String O URL completo do recurso Detalhar

explore:state:changed

Esse 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 relativo do recurso "Explorar" (apenas o caminho)
explore.absoluteUrl String O URL completo do recurso Detalhar

page:changed

Esse evento é criado quando um usuário navega para uma nova página no 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 para a qual acabou de ser feita a navegação, como "dashboard", "look" ou "explore"
page.url String O URL relativo (apenas o caminho) da página para a qual acabou de ser feita a navegação.
page.absoluteUrl String O URL completo da página para a qual a navegação acabou de ser feita.

page:properties:changed

Esse evento é criado quando a altura de um iframe do painel muda. Ele não está disponível para Looks ou análises detalhadas porque esses itens ajustam automaticamente a altura ao tamanho do iframe.

type: "page:properties:changed",
height: 1000
Atributo Formato Descrição
height Número 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 após a criação do iframe e 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 em uma resposta a uma solicitação para gerar tokens ou se a sessão expirou.
authentication_token_ttl Número Tempo de vida do token de autenticação em segundos. Incluído quando o iframe é criado. Não incluído em uma resposta a uma solicitação para gerar tokens ou se a sessão expirou.
api_token String Token de 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 Tempo de vida do token de navegação em segundos. Não incluído se a sessão expirou.
session_references_token_ttl Número Tempo de vida da sessão em segundos. O valor será 0 quando a sessão expirar. Para se recuperar, o aplicativo de incorporação precisa adquirir uma nova sessão.

session:expired

Adicionado em 25/10 Esse evento é acionado quando a sessão do usuário incorporado expira.

type: "session:expired",

Esse evento não tem um payload.

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 Tempo de vida 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 "interrupted" é true. Indica se a sessão pode ser recuperada ou não. Um valor de 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 estar parcialmente fora da visualização, como uma caixa de diálogo de detalhamento. Esse evento permite que o aplicativo host role a caixa de diálogo para a visualização com 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. No momento, apenas a caixa de diálogo de detalhamento é compatível, mas outras poderão ser adicionadas no futuro. É possível que a parte de cima da caixa de diálogo de detalhamento não esteja visível, já que ela cobre a janela de visualização do iframe. Esse evento permite que o aplicativo host role a parte de cima da caixa de diálogo para a visualização.
dialogType String O tipo de caixa de diálogo. Somente a abertura ou o fechamento da caixa de diálogo de detalhamento aciona esse evento.
placement String O posicionamento da caixa de diálogo. As caixas de diálogo do tipo "detalhamento" sempre usam um placement de "cover".
open Booleano Indica se a caixa de diálogo está aberta ou rolada.

Fazer mudanças no iframe

Depois de preparar o iframe para recuperação de dados, siga estas etapas para fazer mudanças nele:

  1. Escreva sua solicitação em JSON.
  2. Poste a solicitação no contentWindow do iframe.

Como escrever sua solicitação em JSON

É possível fazer várias mudanças no iframe, que será enviado em formato JSON. As opções disponíveis são descritas na seção Referência de ação desta página. Não se esqueça de usar JSON.stringify para transformar sua ação em JSON, assim:

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

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 da ação

A tabela a seguir resume as ações. Selecione uma ação para conferir os detalhes dela.

Ação Descrição da ação
page:load Carrega uma nova página no iframe, substituindo a página atual.
dashboard:load Carrega um novo painel no iframe, substituindo um painel atual.
dashboard:run Executa o painel no iframe.
dashboard:edit Adicionado na versão 22.20 Muda o painel para o modo de edição.
dashboard:filters:update Atualiza um filtro de painel no iframe.
dashboard:options:set Grava novos valores no layout e nas propriedades dos elementos do painel.
dashboard:schedule_modal:open Abre o Scheduler, que permite aos usuários entregar conteúdo do Looker a vários destinos.
dashboard:stop Interrompe um painel que está em execução ou recarregando dados.
look:run Executa a análise no iframe.
look:filters:update Atualiza um filtro de análise detalhada no iframe.
explore:run Executa a análise detalhada no iframe.
explore:filters:update Atualiza ou remove um filtro de análise detalhada 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 host para o aplicativo Looker incorporado.

Referência de ação

Estas são as ações disponíveis que você pode postar no iframe incorporado:

page:load

Use essa ação para navegar até um novo conteúdo no iframe, substituindo o conteúdo atual. Essa ação é semelhante à dashboard:load, mas é mais flexível, já que parâmetros adicionais podem ser especificados no URL.

Há diferenças no comportamento que precisam ser consideradas antes de usar page:load. dashboard:load impede a navegação se o painel atual estiver sendo editado. page:load não impede a navegação. O aplicativo host pode determinar se um painel ou Look está sendo editado rastreando dashboard:edit:start, look:edit:start e os eventos de fim de edição correspondentes. Por isso, recomendamos usar o SDK de incorporação. O SDK de incorporação rastreia se um painel ou Look está sendo editado. Assim, é possível consultar a conexão para saber se o conteúdo está sendo editado antes da navegação.

{
    type: 'page:load',
    url: '/embed/dashboard/32?state=california,
    pushHistory: false
}
Atributo Formato Descrição
type String Usar o tipo page:load indica que você quer carregar um novo conteúdo no iframe.
url String O URL do conteúdo a ser carregado.
pushHistory Booleano Se true, o conteúdo carregado vai 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 conteúdo anterior. Se false, o conteúdo atual será substituído, e não será possível usar a navegação do navegador para voltar a ele.

dashboard:load

Use essa ação para carregar um novo painel no iframe, substituindo um painel existente. O novo painel vai começar a executar consultas como se uma nova página 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 true, o painel carregado vai 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 será substituído, e a navegação do navegador não poderá ser usada para voltar a ele.

dashboard:run

Use essa ação para executar o painel no iframe. Essa é a mesma ação de clicar no botão Executar ou Recarregar dados 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

Adicionado 22.20 Use essa ação para mudar um painel atual no iframe para o modo de edição. Essa é a mesma ação de selecionar Editar dashboard no menu do dashboard.

{
  type: "dashboard:edit"
}
Atributo Formato Descrição
type String Usar o tipo dashboard:edit indica que você quer mudar o painel para o modo de edição.

dashboard:filters:update

Use essa ação para atualizar um filtro de dashboard 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ê quer aplicar ao painel. Esse objeto tem o formato: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:options:set

Essa ação fica disponível depois que o evento dashboard:run:complete ocorre.

O incorporador cria a mensagem e a envia ao iframe, mas o painel não responde até depois que dashboard:run:complete ocorre. A ação dashboard:options:set grava novos valores no layout e nas propriedades dos elementos do painel. Somente as propriedades 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 sã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 dos elementos 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",
  • dashboard_id: "string",
  • type: "newspaper",
  • active: boolean,
  • column_width: number,
  • width: number
layouts.dashboard_layout_components Objeto Um ou mais objetos componente de layout do painel retornados pelo atributo options no evento dashboard:run:complete. Eles estarão em um formato semelhante a:

  • id: "string",
  • dashboard_layout_id: "string",
  • dashboard_element_id: "string",
  • row: number,
  • column: number,
  • width: number,
  • height: number,
  • deleted: boolean,
elements Objeto Um ou mais objetos elemento do painel retornados pelo atributo options no evento dashboard:run:complete. Eles estarão em um formato semelhante a:

id: {

  title: "string",

  title_hidden: boolean,

  vis_config: {

    type: "string", title: "string"

  }

}

dashboard:schedule_modal:open

Use essa ação para abrir o Scheduler, que permite aos usuários entregar conteúdo do Looker a 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 Programação.

dashboard:stop

Use essa ação para interromper um painel que está sendo executado ou recarregando dados. Essa é a mesma ação de clicar no botão Cancelar no painel. Um painel que é interrompido usando 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 essa ação para executar a consulta em que o Look se baseia no iframe. Essa ação é semelhante a clicar no botão Executar no Look, com a exceção 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 o Look.

look:filters:update

Use essa ação para atualizar um filtro de análise em um iframe. Não é possível adicionar um novo filtro ao Look 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ê quer aplicar à análise detalhada. Esse objeto tem o formato: {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}

explore:run

Use essa ação para executar a análise detalhada no iframe. Essa ação é semelhante a clicar no botão Executar na Análise detalhada, exceto que o 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 análise detalhada.

explore:filters:update

Use essa ação para atualizar ou remover um filtro de análise detalhada no iframe. Incluir um novo filtro que faz referência a um campo válido adiciona o novo filtro à análise detalhada.

{
  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 análise detalhada.
filters Objeto Os novos filtros que você quer aplicar à análise detalhada. Se filters incluir um filtro que não existe na análise detalhada, mas faz referência a um campo válido, ele será adicionado à análise. Esse objeto tem o formato {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}.
deleteFilters Matriz Os filtros atuais que você quer remover da análise detalhada. O formato da matriz é: ["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 essa 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 host para o aplicativo Looker incorporado.
offsetTop Número O deslocamento da parte de cima do iframe.
offsetLeft Número O deslocamento à esquerda do iframe.
scrollX Número A posição scrollX do host do aplicativo.
scrollY Número A posição scrollY do host do aplicativo.