ObjectId - função de gráfico
A função de gráfico ObjectId() retorna o ID do objeto no qual a expressão é avaliada. A função usa um argumento opcional especificando a qual tipo de objeto a função diz respeito. O objeto pode ser uma pasta ou uma visualização. Essa função está disponível apenas em expressões de gráfico.
Sintaxe:
ObjectId([object_type_str])
Tipo de dados de retorno: string
O único argumento da função, object_type_str, é opcional e se refere a um valor de string representando o tipo do objeto.
| Argumento | Descrição |
|---|---|
| object_type_str | Um valor de string representando o tipo do objeto que está sendo avaliado. |
Se nenhum argumento for especificado na expressão da função, ObjectId() retornará o ID do objeto no qual a expressão é usada. Para retornar o ID do objeto de pasta no qual a visualização aparece, use ObjectId('sheet').
No caso de objetos de visualização aninhados em outros objetos de visualização, especifique o tipo de objeto desejado no argumento da função para resultados diferentes. Por exemplo, para um gráfico de Imagem e texto em um contêiner, use 'text-image' para retornar o objeto Imagem e texto e 'container' para retornar o ID do contêiner.
Faça o seguinte:
-
No modo de análise, adicione o seguinte texto à sua URL:
/options/developer
-
Clique com o botão direito do mouse em uma visualização e clique em
Desenvolvedor. -
Em Propriedades, obtenha o ID do objeto no cabeçalho do diálogo e o tipo de objeto na propriedade "qType".
Limitações:
Essa função pode gerar resultados inesperados quando invocada em um objeto (por exemplo, um botão) dentro de um contêiner que é um item mestre. Essa limitação também se aplica aos itens mestres do painel de filtro, que são contêineres para várias caixas de listagem. Isso se deve à forma como os itens mestres usam a hierarquia de objetos.
A expressão de gráfico ObjectId('sheet') retornará uma string vazia nesses casos, enquanto ObjectId('masterobject') mostrará o identificador do item mestre proprietário.
ObjectId() é frequentemente usado em combinação com as seguintes funções:
| Função | Interação |
|---|---|
| if – função de script e gráfico | As funções if e ObjectId podem ser usadas juntas para criar expressões condicionais. Por exemplo, visualizações podem obter cores condicionais por meio de expressões usando essas funções. |
| InObject - função de gráfico | Semelhante a if, InObject também é usado com ObjectId para criar expressões condicionais. |
Exemplo 1 – Retornar o ID do objeto de gráfico
O exemplo básico a seguir demonstra como retornar o ID de uma visualização.
Faça o seguinte:
-
Abra uma nova pasta e arraste um gráfico de Texto e imagem até a pasta.
-
No painel de propriedades, clique em Adicionar medida.
-
Clique em
para abrir o editor de expressão. -
Cole a seguinte expressão no diálogo:
=ObjectId() -
Clique em Aplicar.
O ID do objeto de Texto e imagem é exibido na visualização.
O mesmo resultado pode ser obtido com a seguinte expressão:
Exemplo 2 – Retornar o ID da pasta
O exemplo básico a seguir demonstra como retornar o ID da pasta na qual uma visualização aparece.
Faça o seguinte:
-
Abra uma nova pasta e arraste um gráfico de Texto e imagem até a pasta.
-
No painel de propriedades, clique em Adicionar medida.
-
Clique em
para abrir o editor de expressão. -
Cole a seguinte expressão no diálogo:
=ObjectId('sheet') -
Clique em Aplicar.
O ID da pasta é exibido na visualização.
Exemplo 3 – Expressão aninhada
O exemplo a seguir mostra como a função ObjectId() pode ser aninhada dentro de outras expressões.
Faça o seguinte:
-
Abra uma nova pasta e arraste um gráfico de Texto e imagem até a pasta.
-
No painel de propriedades, clique em Adicionar medida.
-
Clique em
para abrir o editor de expressão. -
Cole a seguinte expressão no diálogo:
=if(InObject(ObjectId('text-image')), 'In Text & image', 'Not in Text & image')
-
Clique em Aplicar.
O texto In Text & image aparece no gráfico, indicando que o objeto referenciado na expressão é um gráfico de Texto e imagem.
Para obter um exemplo mais detalhado usando cores condicionais, consulte o exemplo em InObject - função de gráfico