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

Class ShapeMap

Class used to map data values to shapes in a scatter plot.

Remark

This class is basically a dictionary that maps data values, or categories, to specific shapes.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- ShapeMap

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Count Contains GetCategories TryGetShape

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>, MarkerShape> & PropertySet<
    TypedArray<System.Object>,
    MarkerShape,
> & PropertyGet<CategoryKey, MarkerShape> & PropertySet<
    CategoryKey,
    MarkerShape,
>

Gets or sets the shape for a category.

Param: category

The category.

Returns

The shape for the category.

Since

2.0

Count

get Count(): number
Gets the number of categories.

Returns number
Since
2.0

Contains

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

Since
2.0

GetCategories

GetCategories(): System.Collections.Generic.IList<CategoryKey>
Gets all categories, sorted according to the category.

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

TryGetShape

TryGetShape(category: CategoryKey, shape: OutParam<MarkerShape>): boolean
Tries to get the shape for a given category, returning true upon success.
Parameters
- category: CategoryKey
  A Spotfire.Dxp.Application.Visuals.CategoryKey object identifying the category.
- shape: OutParam<MarkerShape>
  When this method returns, contains the shape associated with the specified category, if one is found; otherwise null.
Returns boolean
true if this instance contains a shape for the specified category; otherwise, false.

Since
2.0