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

Class ScaleLabels

Represents properties such as renderer which apply to scale labels.

Since

2.0

Hierarchy (view full)

DocumentNode
- ScaleLabels

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context IsAttached Transactions ClearLevelSettings ContainsLevelSettings RemoveLevelSettings SetLevelSettings

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

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.

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, 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

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.

Inherited from DocumentNode.Equals

Default capability

`Readonly`Item

Item: PropertyGet<string | String, ScaleLabelsLevelSettings> & PropertySet<string | String, ScaleLabelsLevelSettings>

Gets the Spotfire.Dxp.Application.Visuals.ScaleLabelsLevelSettings corresponding to the indicated expression.

Param: expressionDisplayName

The display name of an expression on the Spotfire.Dxp.Application.Visuals.ScaleAxis which owns this setting.

Returns

The Spotfire.Dxp.Application.Visuals.ScaleLabelsLevelSettings corresponding to the indicated expression.

Since

2.0

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

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

ClearLevelSettings

ClearLevelSettings(): void
Clears all values except the default value.

Returns void
Since
2.0

ContainsLevelSettings

ContainsLevelSettings(expressionDisplayName): boolean
Checks if there are settings for the indicated expression.
Parameters
- expressionDisplayName: string | String
  The display name of an expression on the Spotfire.Dxp.Application.Visuals.ScaleAxis which owns this setting.
Returns boolean
true if the the indicated expression exists; otherwise false.

Since
2.0

RemoveLevelSettings

RemoveLevelSettings(expressionDisplayName): void
Removes the Spotfire.Dxp.Application.Visuals.ScaleLabelsLevelSettings corresponding to the indicated expression.
Parameters
- expressionDisplayName: string | String
  The display name of an expression on the Spotfire.Dxp.Application.Visuals.ScaleAxis which owns this setting.
Returns void
Since
2.0

SetLevelSettings

SetLevelSettings(expressionDisplayName, typeId): void
Sets the scale value renderer type for a hierarchy level on a categorical axis.
Parameters
- expressionDisplayName: string | String
  The display name of the expression to be rendered.
- typeId: TypeIdentifier
  The type id for the renderer.
Returns void
Since
2.0