EaxAnalyzer.getPvtSortItemDimId

Syntax

getPvtSortItemDimId(pvtSortItemkey: Number, dimkey: Number);

Parameters

pvtSortItemkey. Key of the rule, for which a table action area is created.

dimKey. Express report dimension key.

Description

The getPvtSortItemDimId method returns moniker for sorting of express report table.

Comments

Moniker is an object identifier at server that is a dimension selection with the specified key. The method is recommended to be used when a data range is set that is affected by a sorting rule for table.

The method returns a moniker of the type {session_identifier}!{object_identifier} to create a rule action area of table sorting.

Example

Executing the example requires that the HTML page contains the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). The express report must contain at least one dimension, table, sorting rule.

Determine table sorting moniker:

var eaxAnalyzer = expressBox.getSource();
// Get the first table sorting rule
var sortings = eaxAnalyzer.getMetadata().pivot.sorting.items.it;
var pvtSortItemkey = sortings[0].key;
// Get express report dimensions
var dims = eaxAnalyzer.getDims();
// Determine first dimension key
var dimKey = dims[0].getKey();
var sort = eaxAnalyzer.getPvtSortItemDimId(pvtSortItemkey,dimKey);
// Display table sorting moniker in the console
console.log("Table sorting moniker: " + sort.id);

After executing the example the browser console displays the table sorting moniker:

Table sorting moniker: GDDOGJLAGBEAFOAECCAKPAOFFFEBKIBEHIJHGKOGNJLBBKDN!M!S!EENIIBMLAGBEAFOAEGHLABPENBMCIGOIEDJGBPMBJAICEJDPP!SortItem!21!Selection!10124