newMatchAttributeFilter()

Home > @gooddata/sdk-model > newMatchAttributeFilter

newMatchAttributeFilter() 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 match attribute filter.

Signature:

export declare function newMatchAttributeFilter(attributeOrRef: IAttribute | ObjRef | Identifier, operator: MatchFilterOperator, literal: string, options?: {
    caseSensitive?: boolean;
    negativeSelection?: boolean;
}, localIdentifier?: string): IMatchAttributeFilter;

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
operator	MatchFilterOperator	match operator (contains, startsWith, endsWith)
literal	string	literal string to match (should not be empty for valid filter)
options	{ caseSensitive?: boolean; negativeSelection?: boolean; }	(Optional) optional configuration for case sensitivity and negation
localIdentifier	string	(Optional) optional local identifier for the filter

Returns:

IMatchAttributeFilter

Remarks

Match filters provide literal-based matching with various operators. The literal cannot be empty for a valid filter.