kvision / pl.treksoft.kvision.chart / TooltipOptions

TooltipOptions

(js) data class TooltipOptions

Chart tooltip options.

Constructors

(js)

<init>

Chart tooltip options.

TooltipOptions(enabled: Boolean = true, custom: ((a: Any) -> Unit)? = null, mode: InteractionMode = InteractionMode.NEAREST, intersect: Boolean = true, position: TooltipPosition = TooltipPosition.AVERAGE, callbacks: TooltipCallback? = null, filter: ((item: ChartTooltipItem, data: ChartData) -> Boolean)? = null, itemSort: ((itemA: ChartTooltipItem, itemB: ChartTooltipItem) -> Number)? = null, backgroundColor: Color? = null, titleFontSize: Int = 12, titleFontStyle: FontStyle? = null, titleFontColor: Color? = null, titleFontFamily: String? = null, titleSpacing: Int = 2, titleMarginBottom: Int = 6, bodyFontSize: Int = 12, bodyFontStyle: FontStyle? = null, bodyFontColor: Color? = null, bodyFontFamily: String? = null, bodySpacing: Int = 2, footerFontSize: Int = 12, footerFontStyle: FontStyle? = null, footerFontColor: Color? = null, footerFontFamily: String? = null, footerSpacing: Int = 2, footerMarginTop: Int = 6, xPadding: Int = 6, yPadding: Int = 6, caretPadding: Int = 2, caretSize: Int = 5, cornerRadius: Int = 6, multiKeyBackground: Color? = null, displayColors: Boolean = true, borderColor: Color? = null, borderWidth: Int = 0, titleAlign: TooltipAlign? = null, bodyAlign: TooltipAlign? = null, footerAlign: TooltipAlign? = null)

Properties

(js)

backgroundColor

val backgroundColor: Color?
(js)

bodyAlign

val bodyAlign: TooltipAlign?
(js)

bodyFontColor

val bodyFontColor: Color?
(js)

bodyFontFamily

val bodyFontFamily: String?
(js)

bodyFontSize

val bodyFontSize: Int
(js)

bodyFontStyle

val bodyFontStyle: FontStyle?
(js)

bodySpacing

val bodySpacing: Int
(js)

borderColor

val borderColor: Color?
(js)

borderWidth

val borderWidth: Int
(js)

callbacks

val callbacks: TooltipCallback?
(js)

caretPadding

val caretPadding: Int
(js)

caretSize

val caretSize: Int
(js)

cornerRadius

val cornerRadius: Int
(js)

custom

val custom: ((a: Any) -> Unit)?
(js)

displayColors

val displayColors: Boolean
(js)

enabled

val enabled: Boolean
(js)

filter

val filter: ((item: ChartTooltipItem, data: ChartData) -> Boolean)?
(js)

footerAlign

val footerAlign: TooltipAlign?
(js)

footerFontColor

val footerFontColor: Color?
(js)

footerFontFamily

val footerFontFamily: String?
(js)

footerFontSize

val footerFontSize: Int
(js)

footerFontStyle

val footerFontStyle: FontStyle?
(js)

footerMarginTop

val footerMarginTop: Int
(js)

footerSpacing

val footerSpacing: Int
(js)

intersect

val intersect: Boolean
(js)

itemSort

val itemSort: ((itemA: ChartTooltipItem, itemB: ChartTooltipItem) -> Number)?
(js)

mode

val mode: InteractionMode
(js)

multiKeyBackground

val multiKeyBackground: Color?
(js)

position

val position: TooltipPosition
(js)

titleAlign

val titleAlign: TooltipAlign?
(js)

titleFontColor

val titleFontColor: Color?
(js)

titleFontFamily

val titleFontFamily: String?
(js)

titleFontSize

val titleFontSize: Int
(js)

titleFontStyle

val titleFontStyle: FontStyle?
(js)

titleMarginBottom

val titleMarginBottom: Int
(js)

titleSpacing

val titleSpacing: Int
(js)

xPadding

val xPadding: Int
(js)

yPadding

val yPadding: Int

Extension Functions

(js)

toJs

An extension function to convert configuration class to JS object.

fun TooltipOptions.toJs(): dynamic