Skip to main content

headerTooltip

Optional. Controls the header tooltips

note

The headerTooltip config redefines the value of the tooltip config for the header tooltips.

headerTooltip?: boolean | object;

Default value: true

Example

const grid = new dhx.Grid("grid_container", {
    columns: [
        // columns config
    ],
    data: dataset,
    tooltip: false, // Disable all tooltips
    headerTooltip: true, // Enable all header tooltips
});

When set as an object, the headerTooltip config can have the following properties:

  • force - (optional) forces opening of a tooltip; if set to true, the showDelay and hideDelay settings are ignored, false by default
  • showDelay - (optional) the time period that should pass before showing a tooltip, in ms
  • hideDelay - (optional) the time period that should pass before hiding a tooltip, in ms
  • margin - (optional) the margin between the node and tooltip; 8px by default
  • position - (optional) the position of a tooltip: "right", "bottom", "center", "left", "top"; "bottom" by default
  • css - (optional) the style of a tooltip box
const grid = new dhx.Grid("grid_container", {
    columns: [
        // columns config
    ],
    data: dataset,
    headerTooltip: {
       force: true
    }
});

Change log:

  • The ability to set the headerTooltip config as an object is added in v8.4
  • Added in v8.2