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 full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item Context Count IsAttached Transactions AddBottomNRule AddExpressionRule AddRangeRule AddStringRule AddThresholdRule AddTopNRule Clear Contains GetEnumerator IndexOf Move Remove

Methods

Cast

  • Cast<T1, T2>(this, type): 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

    Returns T1

Equals

  • Equals(obj): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): 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

    Returns null | T1

[iterator]

StaticEquals

  • Equals(objA, objB): 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.

Default capability

ReadonlyItem

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

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

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

AddBottomNRule

  • AddBottomNRule(expression, rank, hideMatchedItems): 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, value, hideMatchedItems): FilterRule

  • Adds a bottom N rule to the end of the collection.

    Parameters

    Returns FilterRule

    The rule that was added.

    Since

    2.0

AddExpressionRule

  • AddExpressionRule(expression, booleanExpression, hideMatchedItems): 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, startValue, endValue, hideMatchedItems): 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, comparisonOperator, value, hideMatchedItems): FilterRule

  • Adds a string rule to the end of the collection.

    Parameters

    Returns FilterRule

    The rule that was added.

    Since

    2.0

AddThresholdRule

  • AddThresholdRule(expression, comparisonOperator, value, hideMatchedItems): FilterRule

  • Adds a threshold rule to the end of the collection.

    Parameters

    Returns FilterRule

    The rule that was added.

    Since

    2.0

AddTopNRule

  • AddTopNRule(expression, rank, hideMatchedItems): 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, value, hideMatchedItems): FilterRule

  • Adds a top N rule to the end of the collection.

    Parameters

    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): 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

GetEnumerator

IndexOf

  • IndexOf(rule): 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, toIndex): 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): boolean

  • Removes the specified rule from the collection.

    Parameters

    Returns boolean

    True if the rule was removed; otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability