HeatmapGL

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : SchemeSpec<HeatmapGL>

Properties

Link copied to clipboard
Link copied to clipboard

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to "below traces".

Link copied to clipboard
Link copied to clipboard
var colorscale: Value?

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string.

Link copied to clipboard

Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array and zsmooth is not false; otherwise it is defaulted to false.

Link copied to clipboard
override var descriptor: MetaDescriptor?
Link copied to clipboard
Link copied to clipboard
var dx: Number

Sets the x coordinate step. See x0 for more info. Default: 1.

Link copied to clipboard
var dy: Number

Sets the y coordinate step. See y0 for more info. Default: 1.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Sets the fill color if contours.type is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

Link copied to clipboard

Flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip". Examples: "x", "y", "x+y", "x+y+z", "all", default: "all". Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

Link copied to clipboard
Link copied to clipboard

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a "text" flag.

Link copied to clipboard
var labels: List<Value>

Data array. Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

Link copied to clipboard

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. Default: ""

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
override val meta: ObservableMutableMeta
Link copied to clipboard
var name: String?

Sets the trace name. The trace name appear as the legend item and on hover.

Link copied to clipboard

Sets the opacity of the trace. Default: 1.

Link copied to clipboard

Sets the orientation of the plot(s). If "vertical" ("horizontal"), the data is visualized along the vertical (horizontal).

Link copied to clipboard

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

Link copied to clipboard

If there are multiple violins that should be sized according to some metric (see scalemode), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's width is undefined, scalegroup will default to the trace's name. In this case, violins with the same names will be linked together. Default: ""

Link copied to clipboard

Determines whether or not an item corresponding to this trace is shown in the legend. Default: true

Link copied to clipboard

Determines whether or not a colorbar is displayed for this trace.

Link copied to clipboard

Sets text elements associated with each (x,y) pair. The same string appears over all the data points. If trace hoverinfo contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

Link copied to clipboard

Sets the text font.

Link copied to clipboard

Sets the position of the text elements with respects to the (x,y) coordinates. Default: "middle center".

Link copied to clipboard

Sets the positions of the text elements with respects to the (x,y) coordinates. Default: "middle center".

Link copied to clipboard

Transposes the z data.

Link copied to clipboard
Link copied to clipboard
var values: List<Value>

Data array. Sets the values of the sectors. If omitted, we count occurrences of each label.

Link copied to clipboard

Enumerated , one of ( true | false | "legendonly" ) Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Default: true.

Link copied to clipboard

Sets the x coordinates.

Link copied to clipboard
var x0: Value?

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step. Default: 0.

Link copied to clipboard

Sets the calendar system to use with x date data.

Link copied to clipboard
open override var xgap: Number

Sets the horizontal gap (in pixels) between bricks.

Link copied to clipboard
open override var xtype: DataType

If "array", the heatmap's x coordinates are given by "x" (the default behavior when x is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when x is not provided).

Link copied to clipboard

Sets the y coordinates.

Link copied to clipboard
var y0: Value?

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Link copied to clipboard

Sets the calendar system to use with y date data.

Link copied to clipboard
open override var ygap: Number

Sets the vertical gap (in pixels) between bricks.

Link copied to clipboard
open override var ytype: DataType

If "array", the heatmap's y coordinates are given by "y" (the default behavior when y is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when y is not provided)

Link copied to clipboard

Z coordinates

Link copied to clipboard

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

Link copied to clipboard
var zmax: Number?

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

Link copied to clipboard
var zmid: Number?

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

Link copied to clipboard
var zmin: Number?

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

Link copied to clipboard
open override var zsmooth: ZsmoothType

Picks a smoothing algorithm use to smooth z data.

Functions

Link copied to clipboard
fun Trace.appendXY(vararg pairs: Pair<Number, Number>)

Append trace values using given pairs of x-y number coordinates

fun Trace.appendXY(x: Number, y: Number, xErr: Number? = null, yErr: Number? = null)

Append x and y axis values to a trace with optional x error xErr and y error yErr

Link copied to clipboard
fun axis(axisName: String): TraceValues
Link copied to clipboard
fun Scheme.color(key: Name? = null): ReadOnlyProperty<Scheme, Color>
Link copied to clipboard
fun colorbar(block: ColorBar.() -> Unit)
Link copied to clipboard
fun domain(block: Domain.() -> Unit)
Link copied to clipboard
fun error_x(block: Error.() -> Unit)
Link copied to clipboard
fun error_y(block: Error.() -> Unit)
Link copied to clipboard
fun Trace.functionXY(xs: Iterable<Number>, function: (Double) -> Number)

Fill trace x and y with values based on given xs and a function for y values. Old values are erased.

fun Trace.functionXY(xRange: IntRange, function: (Int) -> Number)

Fill trace x and y with values based on a given integer xRange and a numeric function. Old values are erased.

fun Trace.functionXY(xRange: ClosedFloatingPointRange<Double>, step: Double = 1.0, function: (Double) -> Number)

Fill values in xRange with given step using given function. Old values are erased.

Link copied to clipboard
open operator override fun get(name: Name): MutableMeta?
Link copied to clipboard
open override fun getValue(name: Name): Value?
Link copied to clipboard
fun hoverlabel(block: Hoverlabel.() -> Unit)
Link copied to clipboard
fun labels(array: Iterable<Any>)
Link copied to clipboard
fun line(block: LayoutLine.() -> Unit)
Link copied to clipboard
fun marker(block: Marker.() -> Unit)
Link copied to clipboard
fun Scheme.numberGreaterThan(minValue: Number, default: Number = minValue, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number ray

Link copied to clipboard
fun Scheme.numberInRange(range: ClosedRange<Double>, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number range

Link copied to clipboard
open operator override fun set(name: Name, node: Meta?)
Link copied to clipboard
open override fun setValue(name: Name, value: Value?)
Link copied to clipboard
fun textfont(block: Font.() -> Unit)
Link copied to clipboard
fun Scheme.toJsonString(): String

Convert any type-safe configurator to json string

Link copied to clipboard
open override fun toMeta(): Laminate
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open fun validate(name: Name, meta: Meta?): Boolean
Link copied to clipboard
fun values(array: Iterable<Any>)