newMatchAttributeFilter()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates a new match attribute filter.
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 | either instance of attribute to create filter for or ref or identifier of attribute’s display form | |
operator | 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
Remarks
Match filters provide literal-based matching with various operators. The literal cannot be empty for a valid filter.