Table of Contents

Class HeatmapRegionContainer

Namespace
OFT.Rendering.Heatmap
Assembly
OFT.Rendering.dll

Levels of a rectangular area of a bar-indexed heatmap: read from a heatmap by GetVolumes(HeatmapRectangle) or written to one by AddRegion(HeatmapRegionContainer).

public class HeatmapRegionContainer
Inheritance
object
HeatmapRegionContainer
Extension Methods

Constructors

HeatmapRegionContainer(HeatmapRectangle, HeatmapLevel[,], decimal)

Creates a container over existing levels.

public HeatmapRegionContainer(HeatmapRectangle coordinates, HeatmapLevel[,] levels, decimal priceLevel)

Parameters

coordinates HeatmapRectangle

Bars and prices of the area.

levels HeatmapLevel[,]

The levels, laid out as described for Array; the array is used as is.

priceLevel decimal

Price step between adjacent rows.

Exceptions

ArgumentNullException

levels is null.

ArgumentOutOfRangeException

priceLevel is not positive.

Properties

Array

The levels, indexed as [bar - Coordinates.StartBar, row]; row 0 is the highest price and the last row is LowPrice. The array is not copied.

public HeatmapLevel[,] Array { get; }

Property Value

HeatmapLevel[,]

Coordinates

Bars and prices of the area.

public HeatmapRectangle Coordinates { get; }

Property Value

HeatmapRectangle

this[int, decimal]

Gets the level of a bar at a price.

public HeatmapLevel this[int bar, decimal price] { get; }

Parameters

bar int

Bar index.

price decimal

Price; it is mapped to a row by its distance from LowPrice, truncated to whole price steps.

Property Value

HeatmapLevel

Exceptions

IndexOutOfRangeException

The bar or the price is outside the area.