Class DiscreteHeatmapChannel

A discrete heatmap channel is used to represent a list of discrete values.

Implements

Hierarchy

DiscreteHeatmapChannel

Implements

IHeatmapChannel

Index

Accessors

channelId channelType dataType description isEnabled name property unit values

Constructors

constructor

Accessors

channelId

get channelId(): string
Gets the unique identifier for the channel.

Returns
The channel ID.

Returns string
Implementation of IHeatmapChannel.channelId
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:62

channelType

get channelType(): ChannelType
Gets the type of the channel.

Returns
The type of the channel.

Returns ChannelType
Implementation of IHeatmapChannel.channelType
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:54

dataType

get dataType(): string
Gets the data type of the channel values.

Returns
The data type.

Returns string
Implementation of IHeatmapChannel.dataType
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:70
set dataType(value: string): void
Sets the data type of the channel values.
Parameters
- value: string
  
  The new data type.
Returns void
Implementation of IHeatmapChannel.dataType
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:78

description

get description(): string
Gets the description of the channel.

Returns
The description of the channel.

Returns string
Implementation of IHeatmapChannel.description
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:94
set description(value: string): void
Sets the description of the channel.
Parameters
- value: string
  
  The new description.
Returns void
Implementation of IHeatmapChannel.description
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:102

isEnabled

get isEnabled(): boolean
Gets a boolean value indicating if this channel is enabled

Returns
a value indicates if this channel is enabled.

Returns boolean
Implementation of IHeatmapChannel.isEnabled
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:142
set isEnabled(value: boolean): void
Sets if this channel is enabled or not
Parameters
- value: boolean
  
  a value indicates if this channel is enabled.
Returns void
Implementation of IHeatmapChannel.isEnabled
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:150

name

get name(): string
Gets the name of the channel.

Returns
The name of the channel.

Returns string
Implementation of IHeatmapChannel.name
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:86

property

get property(): string
Gets the data property represented by this channel.

Returns
The data property represented by this channel.

Returns string
Implementation of IHeatmapChannel.property
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:110

unit

get unit(): string
Gets the unit of measurement for the channel.

Returns
The unit of measurement.

Returns string
Implementation of IHeatmapChannel.unit
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:118
set unit(value: string): void
Sets the unit of measurement for the channel.
Parameters
- value: string
  
  The new unit of measurement.
Returns void
Implementation of IHeatmapChannel.unit
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:126

values

get values(): {
[value: string]: string;
}
Gets the mapping of discrete values to their hex colors.

Returns
The discrete values and hex colors mapping.

Returns {
[value: string]: string;
}
- [value: string]: string
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:134

Constructors

constructor

new DiscreteHeatmapChannel(channelId: string, dataType: string, name: string, description: string, property: string, unit: string, values: {
[value: string]: string;
}): DiscreteHeatmapChannel
Creates an instance of DiscreteHeatmapChannel.
Parameters
- channelId: string
  
  A user-defined unique identifier for the channel.
- dataType: string
  
  The data type of the channel values.
- name: string
  
  The name of the channel.
- description: string
  
  A brief description of the channel.
- property: string
  
  The data property represented by this channel.
- unit: string
  
  The unit of measurement for the channel.
- values: {
  [value: string]: string;
  }
  
  The mapping of discrete values to their hex colors.
  - [value: string]: string
Returns DiscreteHeatmapChannel
- Defined in src/plugins/DataVisualization/Heatmap/discrete-heatmap-channel.ts:30

Class DiscreteHeatmapChannel

Implements

Hierarchy

Implements

Index

Accessors

Constructors

Accessors

channelId

Returns

Returns string

channelType

Returns

Returns ChannelType

dataType

Returns

Returns string

Parameters

value: string

Returns void

description

Returns

Returns string

Parameters

value: string

Returns void

isEnabled

Returns

Returns boolean

Parameters

value: boolean

Returns void

name

Returns

Returns string

property

Returns

Returns string

unit

Returns

Returns string

Parameters

value: string

Returns void

values

Returns

Returns { [value: string]: string; }

[value: string]: string

Constructors

constructor

Parameters

channelId: string

dataType: string

name: string

description: string

property: string

unit: string

values: { [value: string]: string; }

[value: string]: string

Returns DiscreteHeatmapChannel

Settings

Member Visibility

Theme

Returns {
[value: string]: string;
}

values: {
[value: string]: string;
}