filterObjRef()

Home > @gooddata/sdk-model > filterObjRef

filterObjRef() function

Gets reference to object being used for filtering.

Signature:

export declare function filterObjRef(filter: IAbsoluteDateFilter | IRelativeDateFilter | IPositiveAttributeFilter | INegativeAttributeFilter | IArbitraryAttributeFilter | IMatchAttributeFilter): ObjRef;

Parameters

Parameter	Type	Description
filter	IAbsoluteDateFilter | IRelativeDateFilter | IPositiveAttributeFilter | INegativeAttributeFilter | IArbitraryAttributeFilter | IMatchAttributeFilter	filter to work with

Returns:

ObjRef

reference to object used for filtering (display form for attr filters, data set for date filters)

Remarks

For attribute filters, this will be reference to the display form. For date filters this will be reference to the data set. This overload applies to filter types that always have an ObjRef (date filters, arbitrary attribute filter, match attribute filter). Positive and negative attribute filters use ObjRef | ObjRefInScope for displayForm and may return undefined when using local identifiers.