GetObjectDimension - chart function

Overview

Open the Data load editor and add the load script below to a new section.

The load script contains:

• A dataset which is loaded into a data table called Example.

• The following fields in the data table:

  • TransactionDate

  • CustomerID

  • TransactionQuantity

Load script

Example:
LOAD * INLINE [
TransactionDate, CustomerID, TransactionQuantity
2018/08/30, 049681, 13
2018/08/30, 203521, 6
2018/08/30, 203521, 21
];Copy code to clipboard

Results

Load the data and open a sheet. Create a new table and add these fields as dimensions:

• TransactionDate

• CustomerID

• TransactionQuantity

Create the following measures:

• =GetObjectDimension (), to find the first dimension in the table.
• =GetObjectDimension (0), to find the first dimension in the table.
• =GetObjectDimension (1), to find the second dimension in the table.

Looking at the results, you can see how the GetObjectDimension function returns the name of the dimension indicated in the function parameters.

Overview

This example uses the GetObjectDimension function in combination with filter selections. The dimension and measure calculation that appears in the chart object changes based on the filter that you select.

Open the Data load editor and add the load script below to a new section.

The load script contains:

• A dataset which is loaded into two inline data tables: Sales and Filter. The first table, Sales, includes sales data. The second table, Filter, contains a list of field names that will be used as a dimension toggle. The toggle allows you to switch between dimensions in a chart and customize the measure calculation that appears depending on the dimension selected.

• The following fields in the Sales table:

  • Country

  • Salesperson

  • SalesValue

• The following field in the Filter table: FilterField.

Load script

Sales:
LOAD * INLINE [
Country, SalesPerson, SalesValue
USA, John, 500
USA, Alice, 700
Canada, Bob, 300
Canada, Carol, 400
Mexico, Dave, 200
];

Filter:
LOAD * INLINE [
FilterField
Country
SalesPerson
];Copy code to clipboard

Results

1. Load the data and open a sheet. Create a new filter pane and add this field as a dimension:

   • FilterField

2. In the assets panel, under Fields, right-click FilterField and select Field settings. Select the Always one value selected check box, and then click Save.

3. Create a table, and then add a dimension by entering the following expression: 

   • =$(= FilterField)

   • Under Label, enter the following expression to define the column name for the dimension: ='$(= FilterField)'

4. Create the following measure:

   • =If(GetObjectDimension() = 'Country', Sum(SalesValue), Avg(SalesValue)), to sum the sales values if the dimension selected is Country, otherwise to return the average of the sales value when the dimension selected is SalesPerson.

   • Under Label, enter the following expression to define the column name for the measure according to the filter selection: =If(GetObjectDimension() = 'Country', 'Sum(SalesValue)', 'Avg(SalesValue)')

In analysis mode, when you switch between SalesPerson and Country in the FieldFilter filter, the table changes to include the selected dimension and the corresponding measure calculation for that dimension. For example, if you select Country in the filter, the table shows Country as the dimension in the first column. The measure then uses the GetObjectDimension function, equates this to Country, and returns the Sum(SalesValue).