newArbitraryAttributeFilter()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates a new arbitrary attribute filter.
export declare function newArbitraryAttributeFilter(attributeOrRef: IAttribute | ObjRef | Identifier, values: Array<string | null>, negativeSelection?: boolean, localIdentifier?: string): IArbitraryAttributeFilter;
Parameters
Parameter | Type | Description |
|---|---|---|
attributeOrRef | 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
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.