Version 3.18.1

APIs

  • Begin typing in the search box above to see results.
Show:

DataTable.Highlight Class

Module: datatable-highlight
Parent Module: datatable

Available since 3.13.0

Methods

_buildColSelRegex

() protected

Defined in datatable/js/highlight.js:256

Available since 3.13.0

Used to transform the _colNameRegex to a Regular Expression when the column highlighting is initially turned on. If _colNameRegex is not a string when this method is called, no action is taken.

_highlightCell

(
  • e
)
protected

Defined in datatable/js/highlight.js:241

Available since 3.13.0

Method called to turn on or off the cell highlighting when the mouse enters or leaves the cell. This is determined by the event phase of the hover event. Where over will turn on the highlighting and anything else will turn it off.

Parameters:

_highlightCol

(
  • e
)
protected

Defined in datatable/js/highlight.js:220

Available since 3.13.0

Method called to turn on or off the column highlighting when the mouse enters or leaves the column. This is determined by the event phase of the hover event. Where over will turn on the highlighting and anything else will turn it off.

Parameters:

_highlightRow

(
  • e
)
protected

Defined in datatable/js/highlight.js:205

Available since 3.13.0

Method called to turn on or off the row highlighting when the mouse enters or leaves the row. This is determined by the event phase of the hover event. Where over will turn on the highlighting and anything else will turn it off.

Parameters:

_setHighlightCells

(
  • val
)
protected

Defined in datatable/js/highlight.js:175

Available since 3.13.0

Default setter method for cell highlighting. If the value is true, a delegate is created and stored in this._highlightDelegates.cell. This delegate will add/remove the cell highlight classname to/from the cell when the mouse enters/leaves a cell on the tbody

Parameters:

Returns:

val

_setHighlightCols

(
  • val
)
protected

Defined in datatable/js/highlight.js:146

Available since 3.13.0

Default setter method for column highlighting. If the value is true, a delegate is created and stored in this._highlightDelegates.col. This delegate will add/remove the column highlight classname to/from the column when the mouse enters/leaves a column on the tbody

Parameters:

Returns:

val

_setHighlightRows

(
  • val
)
protected

Defined in datatable/js/highlight.js:117

Available since 3.13.0

Default setter method for row highlighting. If the value is true, a delegate is created and stored in this._highlightDelegates.row. This delegate will add/remove the row highlight classname to/from the row when the mouse enters/leaves a row on the tbody

Parameters:

Returns:

val

Properties

_colNameRegex

String protected

Defined in datatable/js/highlight.js:94

Available since 3.13.0

A string that will be used to create Regular Expression when column highlighting is set to true. Uses the css prefix ({prefix}) from the DataTable object to populate.

_colSelector

String protected

Defined in datatable/js/highlight.js:81

Available since 3.13.0

A string that is used to create a column selector when the column is has the mouse over it. Can contain the css prefix ({prefix}) and the column name ({col}). Further substitution will require _highlightCol to be overwritten.

_highlightDelegates

Object protected

Defined in datatable/js/highlight.js:106

Available since 3.13.0

This object will contain any delegates created when their feature is turned on.

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.

AltStyle によって変換されたページ (->オリジナル) /