Column Reference

Config

alignchartColoreditableeditor
emptyTextfilterablefreezeableheadAlign
headerhideableidinChart
minWidthmoveableprintableresizable
sortablesortOrderstyleClasstoolTip
width

align

String   Alignment of this column. Could be "left", "right", "center". Set to 'left' by default.

chartColor

String   To specify color of this column in chart.

editable

Boolean   To specify whether end user can edit cells of this column.

editor

Object   To specify an editor for this column. See Sigma.Column.Editor

emptyText

String   To specify what to show in case of null on this column.

filterable

Boolean   To specify whether end user can take this colum as a criteria

freezeable

Boolean   To specify whether end user can freaze this column via main menu..

headAlign

String   Alignment of this column header. Could be "left", "right", "center". Set to 'left' by default.

header

String   To specify caption of this column.

hideable

Boolean   To specify whether end user can show/hide this column via main menu.

id

String   Id of column.

inChart

Boolean   To specify whether value of this column will appear in chart or not.

minWidth

Number   To specify minimum column width when user resizes column.

moveable

Boolean   To specify whether end user can move this column by dragging it to some place.

printable

Boolean   To specify whether this column will be printed out. Set to true by default.

resizable

Boolean   To specify whether end user can resize this column.

sortable

Boolean   To specify whether end user can sort grid by clicking this column header

sortOrder

String   Could be 'asc', 'desc' or null.

styleClass

String   To specify css style of the column.

toolTip

Boolean   To specify whether tip pop should show up on this column.

width

Number   Width of column in pixel. Percentage not supported.

Properties

editablefilterablefreezeablefrozen
getSortValuehiddenhideablemoveable
rendererresizablesortablesortFn

editable

Boolean   To specify whether end user can edit cells of this column.

filterable

Boolean   To specify whether end user can take this colum as a criteria

freezeable

Boolean   To specify whether end user can freaze this column via main menu..

frozen

Boolean   Whether column is frozen initially

getSortValue

Function   To specify comparable value.

hidden

Boolean   Whether column is hidden initially

hideable

Boolean   To specify whether end user can show/hide this column via main menu.

moveable

Boolean   To specify whether end user can move this column by dragging it to some place.

renderer

Function   Cell renderer .

resizable

Boolean   To specify whether end user can resize this column.

sortable

Boolean   To specify whether end user can sort grid by clicking this column header

sortFn

Function   This function is for developer to define how to sort record.

Method

freezegetColumnIndexgrouphide
setHeadersetWidthshowtoggle
unfreeze

freeze()

To freeze this column.

getColumnIndex()

To get index of this column.

Return Number - Index of this column

group(grouped)

To group or ungroup records by value of this column

Booleangrouped. Group or ungroup.

hide()

To hide this column.

setHeader(header)

To update header inner html.

Stringheader Header inner html

setWidth(newWidth)

To set column width.

NumbernewWidth Column new width in pixel.

show()

To show this column.

toggle()

To show/hide this column.

unfreeze()

To unfreeze this column.

Return Array - Array of records.