About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class FilterRule

Represents a rule that uses a boolean condition to determine the visibility of visualization items.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- FilterRule

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DisplayName Enabled EvaluatePerTrellis Expression HideMatchedItems IsAttached ManualDisplayName RuleCondition Transactions

Methods

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

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

DisplayName

get DisplayName(): string
Gets the displayname that is used for this Rule. It will either be equal to ManualDisplayName or (when that is null) it will be an auto-generated string. This display name is suitable for use in the property pages, but not in the legend (since it shows the definition, rather than the value)

Returns string
Since
2.0

Enabled

get Enabled(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.FilterRule is enabled.

Returns boolean
Since
2.0
set Enabled(value: boolean): void
Parameters
- value: boolean
Returns void

EvaluatePerTrellis

get EvaluatePerTrellis(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.FilterRule should be evaluated per trellis or not.

Returns boolean
Since
2.0
set EvaluatePerTrellis(value: boolean): void
Parameters
- value: boolean
Returns void

Expression

get Expression(): string
Gets or sets the expression this rule is evaluated on.

Returns string
Since
2.0
set Expression(value: string): void
Parameters
- value: string
Returns void

HideMatchedItems

get HideMatchedItems(): boolean
Gets or sets a value indicating whether this rule shows or hides matched items.

Returns boolean
Since
2.0
set HideMatchedItems(value: boolean): void
Parameters
- value: boolean
Returns void

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

ManualDisplayName

get ManualDisplayName(): string
Gets or sets the display name. If set to null, the Rule will be represented with an auto-generated name.

Returns string
Since
2.0
set ManualDisplayName(value: string): void
Parameters
- value: string
Returns void

RuleCondition

get RuleCondition(): RuleCondition
Gets the rule condition.

Returns RuleCondition
Since
2.0

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