Class FilterRuleCollection

Represents a list of rules in a Spotfire.Dxp.Application.Visuals.Visualization that are used to filter visualization items.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- FilterRuleCollection

Implements

Methods

[iterator]

"[iterator]"(): Iterator<FilterRule>
Returns Iterator<FilterRule>
Implementation of IEnumerable.[iterator]

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Implementation of IEnumerable.Cast
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Implementation of IEnumerable.TryCast
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

`Readonly`Item

Item: PropertyGet<number | Int32, FilterRule>

Gets the Spotfire.Dxp.Application.Visuals.FilterRule at the specified index. Includes all filter rules even disabled filter rules.

Param: index

The index.

Returns

The Spotfire.Dxp.Application.Visuals.FilterRule at the specified index.

Since

2.0

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
Gets the count.

Returns number
Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

AddBottomNRule

AddBottomNRule(
    expression: string | String,
    rank: number | Int32,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a bottom N rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- rank: number | Int32
  An integer specifying the rank of the added rule.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0
AddBottomNRule(
    expression: string | String,
    value: ConditionValue,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a bottom N rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- value: ConditionValue
  A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue, that has to evaluate to an integer.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0

AddExpressionRule

AddExpressionRule(
    expression: string | String,
    booleanExpression: string | String,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a new expression rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- booleanExpression: string | String
  The boolean expression.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0

AddRangeRule

AddRangeRule(
    expression: string | String,
    startValue: ConditionValue,
    endValue: ConditionValue,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a range rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- startValue: ConditionValue
  The start value.
- endValue: ConditionValue
  The end value.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0

AddStringRule

AddStringRule(
    expression: string | String,
    comparisonOperator: StringComparisonOperator,
    value: ConditionValue,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a string rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- comparisonOperator: StringComparisonOperator
  The comparison operator.
- value: ConditionValue
  The value.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0

AddThresholdRule

AddThresholdRule(
    expression: string | String,
    comparisonOperator: RuleComparisonOperator,
    value: ConditionValue,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a threshold rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- comparisonOperator: RuleComparisonOperator
  The comparison operator.
- value: ConditionValue
  The threshold value.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0

AddTopNRule

AddTopNRule(
    expression: string | String,
    rank: number | Int32,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a top N rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- rank: number | Int32
  An integer specifying the rank of the added rule.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0
AddTopNRule(
    expression: string | String,
    value: ConditionValue,
    hideMatchedItems: boolean | Boolean,
): FilterRule
Adds a top N rule to the end of the collection.
Parameters
- expression: string | String
  The expression.
- value: ConditionValue
  A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue, that has to evaluate to an integer.
- hideMatchedItems: boolean | Boolean
  Should matched elements be filtered out or in?
Returns FilterRule
The rule that was added.

Since
2.0

Clear

Clear(): void
Clears this collection, removing all filter rules.

Returns void
Since
2.0

Contains

Contains(rule: FilterRule): boolean
Determines whether the collection contains a specified rule.
Parameters
- rule: FilterRule
  The rule to locate in the collection.
Returns boolean
True if the collection contains the specified rule; otherwise, false.

Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.IEnumerator
Returns an enumerator that iterates through a collection.

Returns System.Collections.IEnumerator
An System.Collections.IEnumerator object that can be used to iterate through the collection.

Since
2.0

IndexOf

IndexOf(rule: FilterRule): number
Determines the index of a specific rule in the collection.
Parameters
- rule: FilterRule
  The rule to locate in the collection.
Returns number
The index of the rule if found in the list; otherwise, -1.

Since
2.0

Move

Move(fromIndex: number | Int32, toIndex: number | Int32): void
Moves a rule at the specified index to another location in the collection.
Parameters
- fromIndex: number | Int32
  The zero-based index specifying the location of the item to be moved.
- toIndex: number | Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.0

Remove

Remove(rule: FilterRule): boolean
Removes the specified rule from the collection.
Parameters
- rule: FilterRule
  The rule to remove.
Returns boolean
True if the rule was removed; otherwise false.

Since
2.0

Class FilterRuleCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<FilterRule>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddBottomNRule

Parameters

Returns FilterRule

Since

Parameters

Returns FilterRule

Since

AddExpressionRule

Parameters

Returns FilterRule

Since

AddRangeRule

Parameters

Returns FilterRule

Since

AddStringRule

Parameters

Returns FilterRule

Since

AddThresholdRule

Parameters

Returns FilterRule

Since

AddTopNRule

Parameters

Returns FilterRule

Since

Parameters

Returns FilterRule

Since

Clear

Returns void

Since

Contains

Parameters

`Static`Equals

`Readonly`Item