Utilizar parâmetros nos dashboards do Azure Data Explorer

  • Artigo

Os parâmetros são utilizados como blocos modulares para filtros nos dashboards do Azure Data Explorer. São geridos no âmbito do dashboard e podem ser adicionados às consultas para filtrar os dados apresentados pelo elemento visual subjacente. Uma consulta pode utilizar um ou mais parâmetros.

Este documento descreve a criação e utilização de parâmetros e filtros ligados em dashboards. Os parâmetros podem ser utilizados para filtrar elementos visuais do dashboard ao selecionar valores de parâmetros na barra de filtro ou através de filtros cruzados.

Os exemplos de consulta utilizados neste artigo baseiam-se na StormEvents tabela na galeria de exemplos.

Nota

A gestão de parâmetros está disponível no Modo de edição para editores de dashboards.

Pré-requisitos

Ver lista de parâmetros

Para ver a lista de todos os parâmetros do dashboard, selecione o botão Parâmetros na parte superior do dashboard.

Captura de ecrã a mostrar o botão parâmetros na parte superior do dashboard.

Criar um parâmetro

Para criar um parâmetro:

  1. Mude de Ver para o modo de Edição .

    Captura de ecrã a mostrar o botão de edição na parte superior do dashboard.

  2. Selecione o botão Parâmetros na parte superior do dashboard.

    Captura de ecrã a mostrar o botão parâmetros na parte superior do dashboard.

  3. Selecione o botão + Novo parâmetro na parte superior do painel direito.

  4. Preencha as propriedades relevantes para o parâmetro.

Propriedades suportadas

No painel Adicionar parâmetro , configure as seguintes propriedades:

Campo Descrição
Etiqueta O nome do parâmetro apresentado no dashboard ou no cartão de edição.
Tipo de parâmetro Um dos seguintes parâmetros:
  • Seleção única: apenas um valor pode ser selecionado no filtro como entrada para o parâmetro.
  • Seleção múltipla: um ou mais valores podem ser selecionados no filtro como entradas para o parâmetro.
  • Intervalo de tempo: permite criar parâmetros adicionais para filtrar as consultas e os dashboards com base no tempo. Cada dashboard tem um seletor de intervalo de tempo por predefinição.
  • Texto gratuito: não tem valores preenchidos no filtro. O utilizador pode escrever um valor ou copiar/colar um valor no campo de texto. O filtro mantém os valores recentes utilizados.
Nome da variável O nome do parâmetro a utilizar na consulta. Sugestão: o prefixo de nomes de variáveis com um caráter distinto, como um caráter de sublinhado (_), torna-os mais fáceis de encontrar ao escrever consultas.
Tipo de dados O tipo de dados dos valores dos parâmetros.
Mostrar nas páginas Selecione as páginas onde este parâmetro será apresentado. A opção Selecionar tudo mostra o parâmetro em todas as páginas.
Origem A origem dos valores dos parâmetros:
  • Valores fixos: foram introduzidos manualmente valores de filtro estático.
  • Consulta: os valores introduzidos dinamicamente com uma consulta KQL.
Valor predefinido O valor predefinido do filtro. O filtro começará sempre com o valor predefinido após a composição inicial do dashboard.
Adicionar um valor "Selecionar tudo" Aplicável apenas a seleção única e vários tipos de parâmetros de seleção. Utilizado para obter dados para todos os valores de parâmetros. Este valor deve ser incorporado na consulta para fornecer a funcionalidade. Para obter mais exemplos de criação dessas consultas, veja Utilizar o parâmetro baseado em consultas de seleção múltipla.

Gerir parâmetros

Depois de selecionar Parâmetros na barra superior, pode ver a lista de parâmetros existentes. Em cada cartão de parâmetros, selecione o widget de lápis para editar o parâmetro ou selecione o menu Mais [...] para Duplicar, Eliminar ou mover o parâmetro.

Os indicadores seguintes podem ser visualizados no cartão de parâmetros:

  • Nome a apresentar do parâmetro
  • Nomes de variáveis
  • Número de consultas em que o parâmetro foi utilizado
  • Páginas a que o parâmetro está afixado

Os cartões de parâmetros podem ser ordenados ao arrastar e largar ou ao utilizar a opção Mover para > e selecionar a nova localização.

Captura de ecrã a mostrar os cartões de parâmetros de exemplo.

Utilizar parâmetros na consulta

Tem de ser utilizado um parâmetro na consulta para tornar o filtro aplicável a esse elemento visual de consulta. Uma vez definidos, pode ver os parâmetros na barra superior do filtro da página >consulta e no intellisense da consulta.

Nota

Se o parâmetro não for utilizado na consulta, o filtro permanecerá inativo. Assim que o parâmetro for adicionado à consulta, o filtro fica ativo.

Tipos de parâmetros

São suportados vários tipos de parâmetros de dashboard, da seguinte forma:

Os exemplos seguintes descrevem como utilizar parâmetros numa consulta para vários tipos de parâmetros.

Parâmetro de intervalo de tempo predefinido

Cada dashboard tem um parâmetro intervalo de tempo por predefinição. Aparece no dashboard como um filtro apenas quando utilizado numa consulta. Utilize as palavras-chave _startTime do parâmetro e _endTime utilize o parâmetro de intervalo de tempo predefinido numa consulta, conforme visto no exemplo seguinte:

StormEvents
| where StartTime between (_startTime.._endTime)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

Depois de guardado, o filtro de intervalo de tempo é apresentado no dashboard. Agora pode ser utilizado para filtrar os dados no cartão. Pode filtrar o dashboard ao selecionar a partir do menu pendente: Intervalo de tempo (últimos x minutos/horas/dias) ou um Intervalo de tempo personalizado.

Captura de ecrã a mostrar como filtrar com o intervalo de tempo personalizado.

Parâmetros de valores fixos de seleção única

Os parâmetros de valor fixo baseiam-se em valores predefinidos especificados pelo utilizador. O exemplo seguinte mostra-lhe como criar um único parâmetro de valor fixo de seleção.

Criar um parâmetro de valores fixos de seleção única

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione Novo parâmetro.

  2. Preencha os detalhes da seguinte forma:

    • Etiqueta: Tipo de Evento

    • Tipo de parâmetro: seleção única

    • Nome da variável: _eventType

    • Tipo de dados: Cadeia

    • Afixar como filtro de dashboard: selecionado

    • Origem: Valores fixos

      Neste exemplo, utilize os seguintes valores:

      Valor Nome a apresentar do parâmetro
      Vento trovoada Vento trovoada
      Granizo Granizo
      Inundação repentina Inundação repentina
      Seca Seca
      Tempo de Inverno Tempo de inverno

    • Adicionar um valor Selecionar tudo : Desmarcado

    • Valor predefinido: Vento trovoada

  3. Selecione Concluído para criar o parâmetro .

O parâmetro pode ser visto no painel lateral Parâmetros , mas não está a ser utilizado em nenhum elemento visual.

Utilizar um parâmetro de valores fixos de seleção única

  1. Execute uma consulta de exemplo com o novo parâmetro Event TypTope com o nome da _eventType variável:

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType == _eventType
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    O novo parâmetro aparece na lista de parâmetros na parte superior do dashboard.

  2. Selecione valores diferentes para atualizar os elementos visuais.

    Ecrãs a mostrar o resultado dos cinco principais estados.

Parâmetros de valores fixos de seleção múltipla

Os parâmetros de valor fixo baseiam-se em valores predefinidos especificados pelo utilizador. O exemplo seguinte mostra como criar e utilizar um parâmetro de valor fixo de seleção múltipla.

Criar parâmetros de valores fixos de seleção múltipla

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione Novo parâmetro.

  2. Preencha os detalhes conforme mencionado em Utilizar um parâmetro de valores fixos de seleção única com as seguintes alterações:

    • Etiqueta: Tipo de Evento
    • Tipo de parâmetro: seleção múltipla
    • Nome da variável: _eventType

  3. Selecione Concluído para criar o parâmetro .

Os novos parâmetros podem ser vistos no painel lateral Parâmetros , mas não estão atualmente a ser utilizados em elementos visuais.

Utilizar um parâmetro de valores fixos de seleção múltipla

  1. Execute uma consulta de exemplo com o novo parâmetro Tipo de Evento com a _eventType variável .

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    O novo parâmetro aparece na lista de parâmetros na parte superior do dashboard.

  2. Selecione um ou mais valores diferentes para atualizar os elementos visuais.

    Captura de ecrã a mostrar como selecionar vários tipos de eventos.

Parâmetros baseados em consultas de seleção única

Os valores dos parâmetros baseados em consultas são obtidos durante o carregamento do dashboard ao executar a consulta de parâmetros. O exemplo seguinte mostra-lhe como criar e utilizar um único parâmetro baseado em consulta de seleção.

Criar um parâmetro baseado em consultas de seleção única

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione Novo parâmetro.

  2. Preencha os detalhes conforme mencionado em Utilizar um parâmetro de valores fixos de seleção única com as seguintes alterações:

    • Etiqueta: Estado

    • Nome da variável: _state

    • Origem: Consulta

    • Origem de dados: StormEventsSample

    • Selecione Editar consulta e introduza a seguinte consulta. Selecione Concluído.

      StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
| project State

    • Valor: Estado

    • Nome a apresentar: Estado

    • Valor predefinido: escolher um valor predefinido

  3. Selecione Concluído para criar o parâmetro .

Utilizar um parâmetro baseado em consultas de seleção única

  1. A seguinte consulta de exemplo com o novo parâmetro State utiliza a _state variável :

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State == _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    O novo parâmetro aparece na lista de parâmetros na parte superior do dashboard.

  2. Selecione valores diferentes para atualizar os elementos visuais.

Parâmetros baseados em consultas de seleção múltipla

Os valores dos parâmetros baseados em consultas são derivados no tempo de carregamento do dashboard ao executar a consulta especificada pelo utilizador. O exemplo seguinte mostra como criar um parâmetro baseado em consultas de seleção múltipla:

Criar um parâmetro baseado em consultas de seleção múltipla

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione + Novo parâmetro.

    1. Preencha os detalhes conforme mencionado em Utilizar um parâmetro de valores fixos de seleção única com as seguintes alterações:
    • Etiqueta: Estado
    • Tipo de parâmetro: seleção múltipla
    • Nome da variável: _state

  3. Selecione Concluído para criar o parâmetro .

Utilizar um parâmetro baseado em consultas de seleção múltipla

  1. A seguinte consulta de exemplo utiliza o novo parâmetro State com a _state variável .

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State in (_state) or isempty(_state)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    Nota

    Este exemplo utiliza a opção Selecionar Tudo ao verificar se há valores vazios com a isempty() função .

    O novo parâmetro aparece na lista de parâmetros na parte superior do dashboard.

  2. Selecione um ou mais valores diferentes para atualizar os elementos visuais.

Parâmetros de texto livre

Os parâmetros de texto livre não contêm valores. Permitem-lhe introduzir o seu próprio valor.

Criar um parâmetro de texto livre

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione + Novo parâmetro.

  2. Preencha os detalhes da seguinte forma:

    • Etiqueta: Estado
    • Tipo de parâmetro: texto livre
    • Nome da variável: _state
    • Tipo de dados: Cadeia
    • Valor predefinido: nenhum valor predefinido

Utilizar um parâmetro de texto livre

  1. Execute uma consulta de exemplo com o novo parâmetro State com o nome da _state variável:

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State contains _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

Parâmetros da origem de dados

Depois de adicionar origens de dados ao dashboard, pode criar um parâmetro que seleciona uma ou mais das origens de dados disponíveis. Este parâmetro pode ser utilizado em mosaicos e outros parâmetros.

Criar um parâmetro de origem de dados

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione + Novo parâmetro.

  2. Preencha os detalhes da seguinte forma:

    • Etiqueta: Origem
    • Tipo de parâmetro: origem de dados
    • Mostrar nas páginas: Selecionar tudo
    • Valores: selecione tudo
    • Valor predefinido: StormEventsSample

  3. Selecione Concluído.

O novo parâmetro está agora visível na lista de parâmetros na parte superior do dashboard.

Utilizar um parâmetro de origem de dados

  1. Navegue para a consulta de um mosaico novo ou existente.

  2. Em Origem, selecione o nome do novo parâmetro em Parâmetros da origem de dados. Para o parâmetro criado acima, selecione Cluster.

  3. Selecione Aplicar alterações.

  4. Utilize o parâmetro Cluster para alterar a origem de dados desta consulta ligada.

Parâmetros de filtros cruzados

Os filtros cruzados permitem-lhe selecionar um valor num elemento visual e todos os elementos visuais do dashboard, como gráficos de linhas ou de dispersão, são filtrados para mostrar apenas dados relacionados. A utilização de filtros cruzados obtém o mesmo resultado que selecionar o valor equivalente para o parâmetro na lista de parâmetros na parte superior do dashboard.

Definir filtros cruzados

Para criar um filtro cruzado, tem de ativar a opção no elemento visual e, em seguida, especificar o parâmetro utilizado para filtrar os dados.

  1. Navegue para a consulta do mosaico onde pretende adicionar filtros cruzados.

  2. Selecione Visual.

  3. No painel direito, selecione Interações e, em seguida, ative os filtros cruzados.

  4. Opcionalmente, especifique o Tipo de interação . A predefinição é Ponto onde pode selecionar um valor no elemento visual. Para selecionar um intervalo de valores, como num gráfico de tempo, selecione Arrastar.

  5. Especifique a coluna que é utilizada para fornecer o valor e um parâmetro utilizado para filtrar a consulta.

    Importante

    A coluna e o parâmetro têm de ser do mesmo tipo de dados.

Captura de ecrã a mostrar a página editar elemento visual, com o separador interações.

Interagir com os seus dados através de filtro cruzado

Assim que o filtro cruzado estiver definido, pode utilizá-lo para interagir com os seus dados. Nos elementos visuais onde definiu filtros cruzados, pode selecionar pontos de dados e utilizar os respetivos valores para filtrar a página atual do dashboard. Para elementos visuais de tabela, selecione pontos de dados ao clicar com o botão direito do rato na célula relevante e, em seguida, no menu de contexto, selecione Filtro cruzado.

Captura de ecrã a mostrar um elemento visual de tabela, com a opção de menu de contexto de filtro cruzado.

Pode repor o filtro cruzado ao selecionar Repor na parte superior do elemento visual onde foi selecionado.

Captura de ecrã a mostrar um elemento visual de tabela com o botão repor.

Utilizar pormenorização como parâmetros do dashboard

Com a pormenorização, pode selecionar um valor num elemento visual e utilizá-lo para filtrar os elementos visuais numa página de destino no mesmo dashboard. Quando a página de destino é aberta, o valor é pré-selecionado nos filtros relevantes. Os elementos visuais na página, como gráficos de linhas ou de dispersão, são filtrados para mostrar apenas dados relacionados.

Definir uma pormenorização

Para criar uma pormenorização, primeiro tem de ativá-la no elemento visual e, em seguida, adicionar uma ou mais pormenorização conforme necessário.

  1. Edite o elemento visual onde pretende adicionar uma pormenorização. Certifique-se de que o separador Elemento visual está selecionado.

  2. No painel direito, selecione Interações e, em seguida, ative a pormenorização.

    Captura de ecrã da página de pormenorização a mostrar a opção ativar.

  3. Em Pormenorização, selecione Criar novo e especifique as seguintes informações. Opcionalmente, selecione Adicionar outro par para adicionar vários parâmetros para uma página de destino. Repita este passo para adicionar pormenorização a outras páginas no dashboard atual com parâmetros diferentes.

    Campo Descrição
    Página de destino Uma ou mais páginas de destino para explorar com os parâmetros definidos.
    Coluna A coluna do resultado da consulta a utilizar como o valor de um parâmetro na página de destino.
    Parâmetro O parâmetro utilizado para filtrar elementos visuais na página de destino com o valor da coluna.
    Notas Descrição breve opcional.

    Importante

    Os pares de colunas e parâmetros têm de ter o mesmo tipo de dados.

Interagir com os seus dados através de pormenorização

Assim que as pormenorização forem definidas, pode utilizá-las para interagir com os seus dados. Para tal, em elementos visuais ou tabelas em que definiu uma pormenorização, clique com o botão direito do rato num ponto de dados e, em seguida, selecione Pormenorizar até à>página de destino. Os valores do ponto de dados serão utilizados como parâmetros para filtrar os elementos visuais na página de destino.

Captura de ecrã de um elemento visual do dashboard a mostrar a interação de pormenorização.

Para regressar à página de origem, no canto superior direito da página de destino, selecione Repor. Todos os filtros atribuídos pela pormenorização serão repostos.

Utilizar a pesquisa de filtros para filtros de seleção única e múltipla

Em filtros de seleção simples e múltiplos, escreva o valor que pretende. O filtro é atualizado para mostrar apenas os valores que correspondem ao termo de pesquisa.

Conteúdo relacionado