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

Class HeatMapNormalizationZScoreCalculation

Represents a Z Score Calculation normalization.

Since

2.0

Hierarchy (View Summary)

HeatMapNormalization
- HeatMapNormalizationZScoreCalculation

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

CreateMeanNormalization CreatePercentileNormalization CreateScaleBetween0And1Normalization CreateStandardDeviationNormalization CreateSubtractMeanNormalization CreateSubtractMedianNormalization CreateTrimmedMeanNormalization CreateZScoreCalculationNormalization

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from HeatMapNormalization.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

`Static`CreateMeanNormalization

CreateMeanNormalization(): HeatMapNormalizationMean
Creates a Mean normalization.

Returns HeatMapNormalizationMean
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationMean instance.

Since
2.0

Inherited from HeatMapNormalization.CreateMeanNormalization

`Static`CreatePercentileNormalization

CreatePercentileNormalization(
percentage: number | Double,
): HeatMapNormalizationPercentile
Creates a Percentile normalization.
Parameters
- percentage: number | Double
  The percentage.
Returns HeatMapNormalizationPercentile
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationPercentile instance.

Since
2.0

Inherited from HeatMapNormalization.CreatePercentileNormalization

`Static`CreateScaleBetween0And1Normalization

CreateScaleBetween0And1Normalization(): HeatMapNormalizationScaleBetween0And1
Creates a scale between 0 and 1 normalization.

Returns HeatMapNormalizationScaleBetween0And1
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationScaleBetween0And1 instance.

Since
2.0

Inherited from HeatMapNormalization.CreateScaleBetween0And1Normalization

`Static`CreateStandardDeviationNormalization

CreateStandardDeviationNormalization(): HeatMapNormalizationStandardDeviation
Creates a Standard Deviation normalization.

Returns HeatMapNormalizationStandardDeviation
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationStandardDeviation instance.

Since
2.0

Inherited from HeatMapNormalization.CreateStandardDeviationNormalization

`Static`CreateSubtractMeanNormalization

CreateSubtractMeanNormalization(): HeatMapNormalizationSubtractMean
Creates a Subtract Mean normalization.

Returns HeatMapNormalizationSubtractMean
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationSubtractMean instance.

Since
2.0

Inherited from HeatMapNormalization.CreateSubtractMeanNormalization

`Static`CreateSubtractMedianNormalization

CreateSubtractMedianNormalization(): HeatMapNormalizationSubtractMedian
Creates a Subtract Median normalization.

Returns HeatMapNormalizationSubtractMedian
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationSubtractMedian instance.

Since
2.0

Inherited from HeatMapNormalization.CreateSubtractMedianNormalization

`Static`CreateTrimmedMeanNormalization

CreateTrimmedMeanNormalization(
percentage: number | Double,
): HeatMapNormalizationTrimmedMean
Creates the Trimmed Mean normalization.
Parameters
- percentage: number | Double
  The percentage.
Returns HeatMapNormalizationTrimmedMean
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationTrimmedMean instance.

Since
2.0

Inherited from HeatMapNormalization.CreateTrimmedMeanNormalization

`Static`CreateZScoreCalculationNormalization

CreateZScoreCalculationNormalization(): HeatMapNormalizationZScoreCalculation
Creates a Z score calculation normalization.

Returns HeatMapNormalizationZScoreCalculation
A new Spotfire.Dxp.Application.Visuals.HeatMapNormalizationZScoreCalculation instance.

Since
2.0

Inherited from HeatMapNormalization.CreateZScoreCalculationNormalization