YUI recommends YUI 3.

YUI 2 has been deprecated since 2011. This site acts as an archive for files and documentation.

Yahoo! UI Library

DataTable Widget  2.4.0

Yahoo! UI Library > datatable > YAHOO.widget.Column

Show Private Show Protected

Class YAHOO.widget.Column

The Column class defines and manages attributes of DataTable Columns


YAHOO.widget.Column ( oConfigs )
oConfigs <Object> Object literal of configuration values.


_colspan - private Number

Number of table cells the Column spans.

_minWidth - private Number

Minimum width the Column can support (in pixels). Value is populated only if table is fixedWidth, null otherwise.

_nKeyIndex - private Number

Reference to Column's current position index within its ColumnSet's keys array, if applicable.

_parent - private YAHOO.widget.Column

Column's parent Column instance, or null.

_rowspan - private Number

Number of table rows the Column spans.

_sId - private String

Unique String identifier assigned at instantiation.

_sName - private String

Unique instance name.

_width - private Number

Current offsetWidth of the Column (in pixels).

abbr - String

Column head cell ABBR for accessibility.

children - Object[]

Array of object literals that define children (nested headers) of a Column.

className - String || String[]

Custom CSS class or array of classes to be applied to every cell in the Column.

Column._nCount - private static Number

Internal class variable to index multiple Column instances.

editor - String || HTMLFunction

Defines an editor function, otherwise Column is not editable.

editorOptions - Object

Defines editor options for Column in an object literal of param:value pairs.

formatter - String || HTMLFunction

Defines a format function.

key - String

Associated database field, or null.

label - String

Text or HTML for display as Column's label in the TH element.

resizeable - Boolean

True if Column is resizeable, false otherwise.
Default Value: false

sortable - Boolean

True if Column is sortable, false otherwise.
Default Value: false

sortOptions.defaultOrder - String

Default sort order for Column: "asc" or "desc".
Default Value: null

sortOptions.sortFunction - Function

Custom sort handler.
Default Value: null

width - String

Column width.



Number getColspan ( )
Public accessor returns Column's calculated COLSPAN value.
Returns: Number
Column's COLSPAN value.


String getId ( )
Returns unique ID string.
Returns: String
Unique ID string.


String getKey ( )
Returns unique Column key.
Returns: String
Column key.


Number getKeyIndex ( )
Public accessor returns Column's current position index within its ColumnSet's keys array, if applicable.
Returns: Number
Position index, or null.


YAHOO.widget.Column getParent ( )
Public accessor returns Column's parent instance if any, or null otherwise.
Returns: YAHOO.widget.Column
Column's parent instance.


Number getRowspan ( )
Public accessor returns Column's calculated ROWSPAN value.
Returns: Number
Column's ROWSPAN value.


String toString ( )
Public accessor to the unique name of the Column instance.
Returns: String
Column's unique name.

Copyright © 2007 Yahoo! Inc. All rights reserved.