Skip to content

HeatmapTooltip🔗

Controls tooltip options

Definition🔗

type HeatmapTooltip struct {
    // Controls how the tooltip is shown
    Mode common.TooltipDisplayMode `json:"mode"`
    MaxHeight *float64 `json:"maxHeight,omitempty"`
    MaxWidth *float64 `json:"maxWidth,omitempty"`
    // Controls if the tooltip shows a histogram of the y-axis values
    YHistogram *bool `json:"yHistogram,omitempty"`
    // Controls if the tooltip shows a color scale in header
    ShowColorScale *bool `json:"showColorScale,omitempty"`
}

Methods🔗

UnmarshalJSONStrict🔗

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode HeatmapTooltip from JSON.

Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (heatmapTooltip *HeatmapTooltip) UnmarshalJSONStrict(raw []byte) error

Equals🔗

Equals tests the equality of two HeatmapTooltip objects.

func (heatmapTooltip *HeatmapTooltip) Equals(other HeatmapTooltip) bool

Validate🔗

Validate checks all the validation constraints that may be defined on HeatmapTooltip fields for violations and returns them.

func (heatmapTooltip *HeatmapTooltip) Validate() error

See also🔗