ObjectId - chart function
The ObjectId() chart function returns the ID of the object in which the expression is evaluated. The function takes an optional argument specifying which type of object the function concerns. The object can be a sheet or a visualization. This function is only available in chart expressions.
Syntax:
ObjectId([object_type_str])
Return data type: string
The function's only argument, object_type_str, is optional and refers to a string value representing the type of the object.
| Argument | Description |
|---|---|
| object_type_str | A string value representing the type of the object being evaluated. |
If no argument is specified in the function expression, ObjectId() returns the ID of the object in which the expression is used. To return the ID of the sheet object within which the visualization appears, use ObjectId('sheet').
In the case of visualization objects nested within other visualization objects, specify the desired object type in the function argument for different results. For example, for a Text & image chart within a container, use 'text-image' to return the Text & image object and 'container' to return the ID of the container.
Do the following:
-
In analysis mode, add the following text to your URL:
/options/developer
-
Right-click a visualization and click
Developer. -
Under Properties, obtain the object ID from the dialog header, and the object type from the "qType" property.
Limitations:
This function can give unexpected results when invoked in an object (for example, a button) inside a container which is a master item. This limitation also applies to filter pane master items, which are containers for a number of listboxes. This is because of how master items use the object hierarchy.
The chart expression ObjectId('sheet') will return an empty string in those cases, whereas ObjectId('masterobject') will show the identifier of the owning master item.
ObjectId() is often used in combination with the following functions:
| Function | Interaction |
|---|---|
| if - script and chart function | The if and ObjectId functions can be used together to create conditional expressions. For example, visualizations might achieve conditional coloring through expressions using these functions. |
| InObject - chart function | Similar to if, InObject is also used with ObjectId to create conditional expressions. |
Example 1 – Return chart object ID
The following basic example demonstrates how to return the ID of a visualization.
Do the following:
-
Open a new sheet and drag a Text & image chart onto the sheet.
-
In the properties panel, click Add measure.
-
Click
to open the expression editor. -
Paste the following expression into the dialog:
=ObjectId() -
Click Apply.
The ID of the Text & image object is displayed in the visualization.
The same result can be achieved with the following expression:
Example 2 – Return sheet ID
The following basic example demonstrates how to return the ID of the sheet in which a visualization appears.
Do the following:
-
Open a new sheet and drag a Text & image chart onto the sheet.
-
In the properties panel, click Add measure.
-
Click
to open the expression editor. -
Paste the following expression into the dialog:
=ObjectId('sheet') -
Click Apply.
The ID of the sheet is displayed in the visualization.
Example 3 – Nested expression
The following example shows how the ObjectId() function can be nested inside other expressions.
Do the following:
-
Open a new sheet and drag a Text & image chart onto the sheet.
-
In the properties panel, click Add measure.
-
Click
to open the expression editor. -
Paste the following expression into the dialog:
=if(InObject(ObjectId('text-image')), 'In Text & image', 'Not in Text & image')
-
Click Apply.
The text In Text & image appears in the chart, indicating that the object referenced in the expression is a Text & image chart.
For a more detailed example using conditional coloring, see the example on InObject - chart function.