package chartjs

  1. Overview
  2. Docs
package chartjs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Class type Chartjs.tooltipModelSource

method dataPoints : tooltipItem Js_of_ocaml.Js.t Js_of_ocaml.Js.js_array Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop

The items that we are rendering in the tooltip.

Positioning.

method xPadding : int Js_of_ocaml.Js.readonly_prop
method yPadding : int Js_of_ocaml.Js.readonly_prop
method xAlign : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method yAlign : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop

X and Y readonly_properties are the top left of the tooltip.

method x : float Js_of_ocaml.Js.readonly_prop
method y : float Js_of_ocaml.Js.readonly_prop
method width : float Js_of_ocaml.Js.readonly_prop
method height : float Js_of_ocaml.Js.readonly_prop
method caretX : int Js_of_ocaml.Js.readonly_prop

Where the tooltip points to.

method caretY : int Js_of_ocaml.Js.readonly_prop

Body. The body lines that need to be rendered. Each object contains 3 parameters. before - lines of text before the line with the color square lines - lines of text to render as the main item with color square after - lines of text to render after the main lines.

method body : tooltipBodyLines Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method beforeBody : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.js_array Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method afterBody : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.js_array Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method bodyFontColor : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method __bodyFontFamily : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method __bodyFontStyle : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method __bodyAlign : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method bodyFontSize : int Js_of_ocaml.Js.readonly_prop
method bodySpacing : int Js_of_ocaml.Js.readonly_prop

Title. Lines of text that form the title.

method title : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Indexable.t Js_of_ocaml.Js.readonly_prop
method titleFontColor : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method __titleFontFamily : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method __titleFontStyle : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method titleFontSize : int Js_of_ocaml.Js.readonly_prop
method __titleAlign : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method titleSpacing : int Js_of_ocaml.Js.readonly_prop
method titleMarginBottom : int Js_of_ocaml.Js.readonly_prop

Footer. Lines of text that form the footer.

method footerFontColor : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method __footerFontFamily : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method __footerFontStyle : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method footerFontSize : int Js_of_ocaml.Js.readonly_prop
method __footerAlign : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method footerSpacing : int Js_of_ocaml.Js.readonly_prop
method footerMarginTop : int Js_of_ocaml.Js.readonly_prop

Appearance.

method caretSize : int Js_of_ocaml.Js.readonly_prop
method caretPadding : int Js_of_ocaml.Js.readonly_prop
method cornerRadius : int Js_of_ocaml.Js.readonly_prop
method backgroundColor : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method labelColors : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.js_array Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop

Colors to render for each item in body. This is the color of the squares in the tooltip.

method labelTextColors : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.js_array Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method opacity : float Js_of_ocaml.Js.readonly_prop

Zero opacity is a hidden tooltip.

method legendColorBackground : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method displayColors : bool Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method borderColor : Color.t Js_of_ocaml.Js.t Js_of_ocaml.Js.readonly_prop
method borderWidth : int Js_of_ocaml.Js.readonly_prop