Class ValueRangesHeatmapChannel

A value ranges heatmap channel is to used to represent a list of colored vlaue ranges.

Implements

Hierarchy

ValueRangesHeatmapChannel

Implements

IHeatmapChannel

Index

Accessors

channelId channelType dataType description isEnabled name property unit valueRanges

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/value-ranges-heatmap-channel.ts:151

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/value-ranges-heatmap-channel.ts:143

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/value-ranges-heatmap-channel.ts:159

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/value-ranges-heatmap-channel.ts:175
set description(value: string): void
Sets the description of the channel.
Parameters
- value: string
  
  The new description of the channel.
Returns void
Implementation of IHeatmapChannel.description
- Defined in src/plugins/DataVisualization/Heatmap/value-ranges-heatmap-channel.ts:183

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/value-ranges-heatmap-channel.ts:231
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/value-ranges-heatmap-channel.ts:239

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/value-ranges-heatmap-channel.ts:167

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/value-ranges-heatmap-channel.ts:191

unit

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

Returns
The unit of measurement.

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

valueRanges

get valueRanges(): ValueRange[]
Gets list of ValueRange items used to represent the data values carried through this channel.

Returns
The value ranges.

Returns ValueRange[]
- Defined in src/plugins/DataVisualization/Heatmap/value-ranges-heatmap-channel.ts:215
set valueRanges(value: ValueRange[]): void
Sets list of ValueRange items used to represent the data values carried through this channel.
Parameters
- value: ValueRange[]
  
  The new value ranges.
Returns void
- Defined in src/plugins/DataVisualization/Heatmap/value-ranges-heatmap-channel.ts:223

Constructors

constructor

new ValueRangesHeatmapChannel(channelId: string, dataType: string, name: string, description: string, property: string, unit: string, ranges: ValueRange[]): ValueRangesHeatmapChannel
Creates an instance of ValueRangesHeatmapChannel.
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.
- ranges: ValueRange[]
  
  A list of ValueRange items used to represent the data values carried through this channel.
Returns ValueRangesHeatmapChannel
- Defined in src/plugins/DataVisualization/Heatmap/value-ranges-heatmap-channel.ts:119

Class ValueRangesHeatmapChannel

Implements

Hierarchy

Implements

Index

Accessors

Constructors

Accessors

channelId

Returns

Returns string

channelType

Returns

Returns ChannelType

dataType

Returns

Returns string

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

valueRanges

Returns

Returns ValueRange[]

Parameters

value: ValueRange[]

Returns void

Constructors

constructor

Parameters

channelId: string

dataType: string

name: string

description: string

property: string

unit: string

ranges: ValueRange[]

Returns ValueRangesHeatmapChannel

Settings

Member Visibility

Theme