Class Formatting

Represents formatting settings to be used when rendered. The settings can contain formatters for between 0 and 8 data types, namely Integer, Real, Currency, DateTime, LongInteger, SingleReal, TimeSpan and Boolean. In addition, for each data type a specific formatter can be set for a category or column, specified by a Spotfire.Dxp.Application.Visuals.CategoryKey. This is referred to as "indexed".

Since

2.0

Hierarchy (View Summary)

DocumentNode
- Formatting

Implements

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

BooleanFormatter

get BooleanFormatter(): BooleanFormatter
Gets or sets the Spotfire.Dxp.Application.Visuals.Formatting.TimeSpanFormatter used for the data type TimeSpan.

Returns BooleanFormatter
Since
2.0
set BooleanFormatter(value: BooleanFormatter): void
Parameters
- value: BooleanFormatter
Returns void

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

CurrencyFormatter

get CurrencyFormatter(): NumberFormatter
Gets or sets the Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type Currency.

Returns NumberFormatter
Since
2.0
set CurrencyFormatter(value: NumberFormatter): void
Parameters
- value: NumberFormatter
Returns void

DateTimeFormatter

get DateTimeFormatter(): DateTimeFormatter
Gets or sets the Spotfire.Dxp.Application.Visuals.Formatting.DateTimeFormatter used for the data types Date, Time and DateTime.

Returns DateTimeFormatter
Since
2.0
set DateTimeFormatter(value: DateTimeFormatter): void
Parameters
- value: DateTimeFormatter
Returns void

IndexedBooleanFormatter

get IndexedBooleanFormatter(): IndexedFormatter<BooleanFormatter>
Gets the indexed Spotfire.Dxp.Application.Visuals.Formatting.BooleanFormatter used for the data type Boolean.

Returns IndexedFormatter<BooleanFormatter>
Since
2.0

IndexedCurrencyFormatter

get IndexedCurrencyFormatter(): IndexedFormatter<NumberFormatter>
Gets the indexed Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type Currency.

Returns IndexedFormatter<NumberFormatter>
Since
2.0

IndexedDateTimeFormatter

get IndexedDateTimeFormatter(): IndexedFormatter<DateTimeFormatter>
Gets the indexed Spotfire.Dxp.Application.Visuals.Formatting.DateTimeFormatter used for the data types Date, Time and DateTime.

Returns IndexedFormatter<DateTimeFormatter>
Since
2.0

IndexedIntegerFormatter

get IndexedIntegerFormatter(): IndexedFormatter<NumberFormatter>
Gets the indexed Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type Integer.

Returns IndexedFormatter<NumberFormatter>
Since
2.0

IndexedLongIntegerFormatter

get IndexedLongIntegerFormatter(): IndexedFormatter<NumberFormatter>
Gets the indexed Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type LongInteger.

Returns IndexedFormatter<NumberFormatter>
Since
2.0

IndexedRealFormatter

get IndexedRealFormatter(): IndexedFormatter<NumberFormatter>
Gets the indexed Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type Real.

Returns IndexedFormatter<NumberFormatter>
Since
2.0

IndexedSingleRealFormatter

get IndexedSingleRealFormatter(): IndexedFormatter<NumberFormatter>
Gets the indexed Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type SingleReal.

Returns IndexedFormatter<NumberFormatter>
Since
2.0

IndexedTimeSpanFormatter

get IndexedTimeSpanFormatter(): IndexedFormatter<TimeSpanFormatter>
Gets the indexed Spotfire.Dxp.Application.Visuals.Formatting.TimeSpanFormatter used for the data type TimeSpan.

Returns IndexedFormatter<TimeSpanFormatter>
Since
2.0

IntegerFormatter

get IntegerFormatter(): NumberFormatter
Gets or sets the Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type Integer.

Returns NumberFormatter
Since
2.0
set IntegerFormatter(value: NumberFormatter): void
Parameters
- value: NumberFormatter
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

LongIntegerFormatter

get LongIntegerFormatter(): NumberFormatter
Gets or sets the Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type LongInteger.

Returns NumberFormatter
Since
2.0
set LongIntegerFormatter(value: NumberFormatter): void
Parameters
- value: NumberFormatter
Returns void

RealFormatter

get RealFormatter(): NumberFormatter
Gets or sets the Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type Real.

Returns NumberFormatter
Since
2.0
set RealFormatter(value: NumberFormatter): void
Parameters
- value: NumberFormatter
Returns void

SingleRealFormatter

get SingleRealFormatter(): NumberFormatter
Gets or sets the Spotfire.Dxp.Data.Formatters.NumberFormatter used for the data type SingleReal.

Returns NumberFormatter
Since
2.0
set SingleRealFormatter(value: NumberFormatter): void
Parameters
- value: NumberFormatter
Returns void

TimeSpanFormatter

get TimeSpanFormatter(): TimeSpanFormatter
Gets or sets the Spotfire.Dxp.Application.Visuals.Formatting.TimeSpanFormatter used for the data type TimeSpan.

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

Clear

Clear(): void
Clears all formatting settings for all data types, non-indexed as well as indexed.

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

Class Formatting

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

BooleanFormatter

Returns BooleanFormatter

Since

Parameters

Returns void

Context

Returns INodeContext

Since

CurrencyFormatter

Returns NumberFormatter

Since

Parameters

Returns void

DateTimeFormatter

Returns DateTimeFormatter

Since

Parameters

Returns void

IndexedBooleanFormatter

Returns IndexedFormatter<BooleanFormatter>

Since

IndexedCurrencyFormatter

Returns IndexedFormatter<NumberFormatter>

Since

IndexedDateTimeFormatter

Returns IndexedFormatter<DateTimeFormatter>

Since

IndexedIntegerFormatter

Returns IndexedFormatter<NumberFormatter>

Since

IndexedLongIntegerFormatter

Returns IndexedFormatter<NumberFormatter>

Since

IndexedRealFormatter

Returns IndexedFormatter<NumberFormatter>

Since

IndexedSingleRealFormatter

Returns IndexedFormatter<NumberFormatter>

Since

IndexedTimeSpanFormatter

Returns IndexedFormatter<TimeSpanFormatter>

Since

IntegerFormatter

Returns NumberFormatter

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

LongIntegerFormatter

Returns NumberFormatter

Since

`Static`Equals