Class AxisBinding

Axis bindings are used to base the expression on an axis on currently marked value in a column.

Remark

Axis bindings can be used to create visualizations whose axis expressions change in response to marking in another visualization.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- AxisBinding

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor ColumnReference Context ExpressionTemplate IsAttached MarkingReference Transactions ForEachNodeInSubTree

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

constructor

new AxisBinding(): AxisBinding
Initializes a new instance of the Spotfire.Dxp.Application.Visuals.AxisBinding class.

Returns AxisBinding
Since
2.0

Overrides Framework.DocumentModel.DocumentNode.constructor

ColumnReference

get ColumnReference(): DataColumn
Gets or sets the data column containing the values used to control the expression on an axis.

Returns DataColumn
Remark
This column would typically contain names of columns in another table, or parts of names that can be combined with the Spotfire.Dxp.Application.Visuals.AxisBinding.ExpressionTemplate property to generate an expression.

Since
2.0
set ColumnReference(value: DataColumn): void
Parameters
- value: DataColumn
Returns void

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

ExpressionTemplate

get ExpressionTemplate(): string
Gets or sets the expression template used to build the expression. Defaults to an empty string.

Returns string
Remark
Set this property to specify how values should be used when building the axis expression. The format is a string where the sequence {0} represents the value. Given the value Sales, the template Sum({0}) evaluates to the expression Sum([Sales]).Given the value Region, the template <{0} NEST [Year]> evauates to the expression <[Region] NEST [Year]>.

By default, this property is an empty string. This enables automatic mode where the marked cell value is passed through a heuristics function to generate an appropriate aggregation method, if required.

Since
2.0
set ExpressionTemplate(value: string): void
Parameters
- value: string
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

MarkingReference

get MarkingReference(): DataMarkingSelection
Gets or sets the marking that controls which row in the column defined by the Spotfire.Dxp.Application.Visuals.AxisBinding.ColumnReference property that should be used for the axis expression.

Returns DataMarkingSelection
Since
2.0
set MarkingReference(value: DataMarkingSelection): void
Parameters
- value: DataMarkingSelection
Returns void

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

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

Class AxisBinding

Remark

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

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

constructor

Returns AxisBinding

Since

ColumnReference

Returns DataColumn

Remark

Since

Parameters

Returns void

Context

Returns INodeContext

Since

ExpressionTemplate

Returns string

Remark

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

MarkingReference

Returns DataMarkingSelection

Since

Parameters

Returns void

Transactions

Returns ITransactions

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals