TooltipOptions

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

Chart tooltip options.

Constructors

TooltipOptions
Link copied to clipboard
fun 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: Chart.ChartTooltipItem, data: Chart.ChartData) -> Boolean? = null, itemSort: (itemA: Chart.ChartTooltipItem, itemB: Chart.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

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

Extensions

toJs
Link copied to clipboard
fun TooltipOptions.toJs(): dynamic
An extension function to convert configuration class to JS object.