Esta página se refere ao parâmetro
description
que faz parte de um Explorar.O
description
também pode ser usado como parte de um campo, descrito na página de documentação do parâmetrodescription
(para campos).
description
também pode ser usado como parte de um painel, descrito na página de documentação Parâmetros do painel.
Uso
description: "Descrição que quero"
}
Hierarquia
description |
Valor padrão
NenhumaAceita
Uma string |
Definição
description
permite que você adicione informações sobre o Explorar à IU. Assim, os usuários podem ver mais informações ao criar relatórios. Por exemplo, veja um parâmetro description
:
explore: order_items {
description: "Based on the individual items that comprise customer orders"
}
Se um description
for adicionado a um recurso "Explorar", os usuários poderão ver a descrição passando o cursor sobre o ícone de informações ao lado do nome do recurso na parte de cima do seletor de campos:
Os usuários também podem usar o mesmo ícone de informação na lista suspensa de "Explorar":
Se você não adicionar explicitamente um description
a uma exploração, nenhuma descrição será exibida.
Examples
Adicione uma descrição a um recurso Explorar chamado Usuário:
explore: user {
description: "All customer users, staff users are excluded"
}