newAttributeColumnLocator()

Home > @gooddata/sdk-ui-pivot > newAttributeColumnLocator

newAttributeColumnLocator() function

Creates a new attribute column locator

Signature:

export declare function newAttributeColumnLocator(attributeOrId: IAttribute | string, element?: string): IAttributeColumnLocator;

Parameters

Parameter	Type	Description
attributeOrId	IAttribute | string	Column attribute specified by either value or by localId reference
element	string	(Optional) specify attribute element URI or primary key; if not specified, the locator will match all elements of the attribute

Returns:

IAttributeColumnLocator

Remarks

This is used to narrow down location of measure columns in pivot table, where measures are further scoped by different attribute elements - imagine pivot table with defined for measure 'Amount' and column attribute 'Product'. The table will have multiple columns for the 'Amount' measure - each for different element of the 'Product' attribute. In this context, identifying particular measure columns needs to be more specific.

The attribute column locator can match either single element of particular attribute, or all elements of particular attribute.