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

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

BooleanFormatter Context CurrencyFormatter DateTimeFormatter IndexedBooleanFormatter IndexedCurrencyFormatter IndexedDateTimeFormatter IndexedIntegerFormatter IndexedLongIntegerFormatter IndexedRealFormatter IndexedSingleRealFormatter IndexedTimeSpanFormatter IntegerFormatter IsAttached LongIntegerFormatter RealFormatter SingleRealFormatter TimeSpanFormatter Transactions Clear

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

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

BooleanFormatter

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

CurrencyFormatter

DateTimeFormatter

IndexedBooleanFormatter

IndexedCurrencyFormatter

IndexedDateTimeFormatter

IndexedIntegerFormatter

IndexedLongIntegerFormatter

IndexedRealFormatter

IndexedSingleRealFormatter

IndexedTimeSpanFormatter

IntegerFormatter

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

LongIntegerFormatter

RealFormatter

SingleRealFormatter

TimeSpanFormatter

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Clear

  • Clear(): void

  • Clears all formatting settings for all data types, non-indexed as well as indexed.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability