HeatmapProperties

Interface HeatmapPropertiesExperimental

Experimental. May be changed in the future without notice.

Example curve for visualization of terms below:

         #####       ↑
       #########
      ###########    strength
     #############
   ################# ↓
            ← size →
           ↑
        position
interface HeatmapProperties {
    enabled?: boolean;
    name?: string;
    position?: number[];
    size?: number[];
    strength?: number[];
    transform?:
        | Float32Array<ArrayBufferLike>
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ];
}

Properties

enabled? name? position? size? strength? transform?

Properties

Optional Experimentalenabled

enabled?: boolean

Whether this dataset should be included in the density calculation.

Default

true

Optional Experimentalname

name?: string

Optional. Name of the heatmap.

Default

undefined

Optional Experimentalposition

position?: number[]

Position of data points. Each set of three consecutive values is interpreted as x, y and z coordinates of a data point.

Optional Experimentalsize

size?: number[]

Optional. Per-point range modifier. Can be used to manipulate the reach of a data point, e.g. scaled by significance.

Default

undefined

Optional Experimentalstrength

strength?: number[]

Optional. Per-point maximum density modifier. Can be used to manipulate the density at the center of a data point, e.g. scaled by significance.

Default

undefined

Optional Experimentaltransform

transform?:
    | Float32Array<ArrayBufferLike>
    | [
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
    ]

Model matrix, can be used to match geometry transformations.

Default

[1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]
Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: