API Docs for: 3.18.1

DataTable.Highlight Class

Defined in: datatable/js/highlight.js:12
Module: datatable-highlight
Parent Module: datatable

Available since 3.13.0

Item Index

Methods

Properties

Attributes

Methods

Properties

highlightClassNames

Object public

Defined in datatable/js/highlight.js:65

Available since 3.13.0

An object consisting of classnames for a row, a col and a cell to be applied to their respective objects when the user moves the mouse over the item and the attribute is set to true.

Attributes

highlightCells

Defined in datatable/js/highlight.js:47

Available since 3.13.0

Setting this to true will create a delegate on the DataTable adding the default classname to the cell when the mouse is over it.

Default: false

Fires event highlightCellsChange

Fires when the value for the configuration attribute highlightCells is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

highlightCols

Defined in datatable/js/highlight.js:33

Available since 3.13.0

Setting this to true will create a delegate on the DataTable adding the default classname to the column when the mouse is over the column.

Default: false

Fires event highlightColsChange

Fires when the value for the configuration attribute highlightCols is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

highlightRows

Defined in datatable/js/highlight.js:19

Available since 3.13.0

Setting this to true will create a delegate on the DataTable adding the default classname to the row when the mouse is over the row.

Default: false

Fires event highlightRowsChange

Fires when the value for the configuration attribute highlightRows is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.