Heatmap

open class Heatmap : Trace, Table2D, HeatmapContour

Types

Companion

common

object Companion : SchemeSpec<Heatmap>

Functions

axis

common

fun axis(axisName: String): TraceValues

colorbar

common

fun colorbar(block: ColorBar.() -> Unit)

domain

common

fun domain(block: Domain.() -> Unit)

error_x

common

fun error_x(block: Error.() -> Unit)

error_y

common

fun error_y(block: Error.() -> Unit)

getItem

common

open override fun getItem(name: Name): MetaItem?

hoverlabel

common

fun hoverlabel(block: Hoverlabel.() -> Unit)

labels

common

fun labels(array: Iterable<Any>)

line

common

fun line(block: LayoutLine.() -> Unit)

marker

common

fun marker(block: Marker.() -> Unit)

onChange

common

open override fun onChange(owner: Any?, action: (Name, MetaItem?, MetaItem?) -> Unit)

removeListener

common

open override fun removeListener(owner: Any?)

setItem

common

open override fun setItem(name: Name, item: MetaItem?)

textfont

common

fun textfont(block: Font.() -> Unit)

toMeta

common

open override fun toMeta(): Laminate

validateItem

common

open fun validateItem(name: Name, item: MetaItem?): Boolean

values

common

fun values(array: Iterable<Any>)

Properties

axis

common

val axis: ReadOnlyProperty<Scheme, TraceValues>

cliponaxis

common

var cliponaxis: Boolean?

Determines whether or not markers and text nodes are clipped about the subplot axes.

colorbar

common

var colorbar: ColorBar

colorscale

common

var colorscale: Value?

Sets the colorscale.

connectgaps

common

var connectgaps: Boolean?

Determines whether or not gaps (i.e.

defaultLayer

common

open val defaultLayer: Meta

descriptor

common

override var descriptor: NodeDescriptor?

domain

common

var domain: Domain

common

var dx: Number

Sets the x coordinate step.

common

var dy: Number

Sets the y coordinate step.

error_x

common

var error_x: Error

error_y

common

var error_y: Error

fillcolor

common

val fillcolor: Color

Sets the fill color if contours.type is "constraint".

hoverinfo

common

var hoverinfo: String?

Flaglist string.

hoverlabel

common

var hoverlabel: Hoverlabel

labels

common

var labels: List<Value>

Data array.

legendgroup

common

var legendgroup: String?

Sets the legend group for this trace.

line

common

var line: LayoutLine

marker

common

var marker: Marker

name

common

var name: String?

Sets the trace name.

opacity

common

var opacity: Number

Sets the opacity of the trace.

orientation

common

var orientation: Orientation

Sets the orientation of the plot(s).

reversescale

common

var reversescale: Boolean?

Reverses the color mapping if true.

scalegroup

common

var scalegroup: String?

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.

showlegend

common

var showlegend: Boolean?

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

showscale

common

var showscale: Boolean?

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

text

common

var text: TraceValues

Sets text elements associated with each (x,y) pair.

textfont

common

var textfont: Font

Sets the text font.

textposition

common

var textposition: TextPosition

Sets the position of the text elements with respects to the (x,y) coordinates.

textpositionsList

common

var textpositionsList: List<Value>

Sets the positions of the text elements with respects to the (x,y) coordinates.

transpose

common

var transpose: Boolean?

Transposes the z data.

type

common

var type: TraceType

values

common

var values: List<Value>

Data array.

visible

common

var visible: Visible

Enumerated , one of ( true | false | "legendonly" ) Determines whether or not this trace is visible.

common

val x: TraceValues

Sets the x coordinates.

common

var x0: Value?

Alternate to x.

xcalendar

common

var xcalendar: Calendar

Sets the calendar system to use with x date data.

xgap

common

open override var xgap: Number

Sets the horizontal gap (in pixels) between bricks.

xtype

common

open override var xtype: DataType

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

common

val y: TraceValues

Sets the y coordinates.

common

var y0: Value?

Alternate to y.

ycalendar

common

var ycalendar: Calendar

Sets the calendar system to use with y date data.

ygap

common

open override var ygap: Number

Sets the vertical gap (in pixels) between bricks.

ytype

common

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)

common

var z: TraceValues

Z coordinates

zauto

common

var zauto: Boolean?

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.

zmax

common

var zmax: Number?

Sets the upper bound of the color domain.

zmid

common

var zmid: Number?

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point.

zmin

common

var zmin: Number?

Sets the lower bound of the color domain.