header model

Contains the properties (text, image, tooltip etc.) of the grid column headers.

Syntax

var value = obj.getHeaderProperty(name); // Retrieve property by name
obj.setHeaderProperty(name, value);      // Assign property value
obj.defineHeaderProperty(name, value);   // Define new property

var external = obj.getHeaderModel();     // Get reference to external model
obj.setHeaderModel(external);            // Assign external model
obj.clearHeaderModel();                  // Clear/reset all properties

Properties

count	Number of header rows.
data	Header data.
format	Header formatting object.
height	Height of the header row.
image	Header image.
indices	Array of header row indices.
link	Header hyperlink URL.
offset	Offset of the first header row.
state	Header row state.
text	Header text.
tooltip	Header tooltip.
value	Header value.
visible	Indicates whether headers are visible.

Defined in

Used by

header template, headers template, top template (extended)

Examples

obj.setHeaderText("header text", 0); 
obj.setHeaderImage("favorites", 0);
obj.setHeaderTooltip("tooltip text", 0);

See also

Grid templates: header
Related models: column, cell, top, footer