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

Class IndexedFormatter<T>

Represents several Spotfire.Dxp.Data.Formatters.DataFormatterBase instances split up by a category or column.

Since

2.0

Type Parameters

T extends DataFormatterBase

Hierarchy (View Summary)

Spotfire.Object
- IndexedFormatter

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Categories Clear Contains

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 Object.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 Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.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 Object.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 Object.Equals

Default capability

`Readonly`Item

Item: PropertyGet<TypedArray<System.Object>, JsType<T>> & PropertySet<
    TypedArray<System.Object>,
    T | JsType<T>,
> & PropertyGet<CategoryKey, JsType<T>> & PropertySet<
    CategoryKey,
    T
    | JsType<T>,
>

Gets or sets the formatting for a category or column.

Param: categories

The expression for a category or column.

Returns

The formatting for the category or column.

Since

2.0

Categories

get Categories(): System.Collections.Generic.IEnumerable<CategoryKey>
Gets all categories in this Spotfire.Dxp.Application.Visuals.IndexedFormatter, including the always present Spotfire.Dxp.Application.Visuals.CategoryKey.Empty. Spotfire.Dxp.Application.Visuals.CategoryKey.Empty is the same object as the non-indexed Spotfire.Dxp.Data.Formatters.DataFormatterBase.

Returns System.Collections.Generic.IEnumerable<CategoryKey>
Since
2.0

Clear

Clear(): void
Clears all values.

Returns void
Since
2.0

Contains

Contains(category: CategoryKey): boolean
Determines whether this Spotfire.Dxp.Application.Visuals.IndexedFormatter contains a formatter for a specific category or column.
Parameters
- category: CategoryKey
  A Spotfire.Dxp.Application.Visuals.CategoryKey identifying the category or column.
Returns boolean
true if there is a formatter for the given category; otherwise, false.

Since
2.0
Contains(...category: any[]): boolean
Determines whether this Spotfire.Dxp.Application.Visuals.IndexedFormatter contains a formatter for a specific category or column.
Parameters
- ...category: any[]
  An object identifying the category or column.
Returns boolean
true if there is a formatter for the given category; otherwise, false.

Since
2.0