Class

PositionArgs

PositionArgs(args)

Positional options for the heatmap.

Constructor

# new PositionArgs(args)

Initialize the PositionArgs object from the provided options. Handles deprecation warnings and calls calculate to pre-calculate values.

Parameters:
Name Type Description
args PositionOptions

object with positional options

Properties:
Name Type Description
rowSpacePx number

space between rows, in pixels. Calculated

rowBigspacePx number

space between groups of rows, in pixels. Calculated

colSpacePx number

space between columns, in pixels. Calculated

geomSize number

size of a heatmap element, in pixels. Calculated

geomPadding number

padding around heatmap elements, in pixels. Calculated

geomPaddingX number

padding around heatmap elements in the x direction, in pixels. Calculated

bodyHeight number

height of the heatmap body, in pixels. Calculated

bodyWidth number

width of the heatmap body, in pixels. Calculated

width number

width of the heatmap, in pixels, including header and footer. Calculated

headerHeight number

height of the header, in pixels. Calculated

footerHeight number

height of the footer, in pixels. Calculated

footerOffset number

offset of the footer from the left edge of the heatmap, in pixels. Calculated

View Source main.js, line 134

Extends

Methods

# calculate()

Pre-calculate needed values based on the options.

View Source main.js, line 178