newArbitraryAttributeFilter()

Home > @gooddata/sdk-model > newArbitraryAttributeFilter

newArbitraryAttributeFilter() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates a new arbitrary attribute filter.

Signature:

export declare function newArbitraryAttributeFilter(attributeOrRef: IAttribute | ObjRef | Identifier, values: Array<string | null>, negativeSelection?: boolean, localIdentifier?: string): IArbitraryAttributeFilter;

Parameters

Parameter	Type	Description
attributeOrRef	IAttribute | ObjRef | Identifier	either instance of attribute to create filter for or ref or identifier of attribute's display form
values	Array<string | null>	arbitrary values to filter by; can be empty array; use null for empty/missing values
negativeSelection	boolean	(Optional) whether this is a negative filter (NOT IN); defaults to false
localIdentifier	string	(Optional) optional local identifier for the filter

Returns:

IArbitraryAttributeFilter

Remarks

Arbitrary filters allow specifying custom string values that don't need to exist as actual attribute elements. Useful for custom/external data integration scenarios.