cpr.controls.gridpart.GridHeaderColumn

Hierarchy

Properties

Name	Type	Description
autoFit	Boolean	Returns the autoFit settings of the header cell.
cellIndex	Number	Returns the cellIndex of the cell.
cellProp	GridCellProp	Returns the configuration information of the cell.
colIndex	Number	Returns the colIndex constituting the cell.
colSpan	Number	Returns the colSpan that composes the cell.
columnName	String	Returns the column name of the DataSet mapped to the cell.
columnType	String	Returns the columnType set in the cell.
control	UIControl	Returns the controls in that cell.
controlType	String	Returns the control type of the control in that cell.
emptyValueSort	EMPTYVALUESORT	When header sort is used (sortable=true), processing of empty values is returned.
expr	String	Returns the expression set in the cell.
fieldLabel	String	Returns the logical field name of the cell.
filterDialogPosition	FilterDialogPosition	Returns the location where the filter popup will be deployed.
filterDialogTitle	String	When the filter function is used (filterable=true), the title of the filter dialog is returned.
filterable	Boolean	For cells in the header area, returns whether to use the multi-filter function through the column value specified by targetColumnName for the cell.
formula	String	Returns the function expression to be expressed in a cell when exporting to Excel.
resizable	Boolean	Returns the resizable settings of the header cell.
rowIndex	Number	Returns the rowIndex constituting the cell.
rowSpan	Number	Returns the rowSpan that composes the cell.
sortColumnName	#column	In the case of a cell in the header area, the column name to be sorted is returned when the cell is clicked.
sortKeyExpression	#expression	When using header sorting (sortable=true), returns the expression by which to be sorted.
sortable	Boolean	In the case of a cell in the header area, it returns whether to use the multi-sort function through the column value specified by targetColumnName in the cell.
style	GridStyler	Returns the style settings.
targetColumnName	#column	In the case of a cell in the header area, the target dataset column name of the function is returned when filterable or sortable of the cell is used.
text	StyledString	Returns the text set in the cell.
tooltip	String	Get a cell tooltip.
visible	Boolean	Returns the visible setting of the header cell.

Methods

Name	Return Type	Description
ariaLabel	String	Applies the entered ariaLabel value to the aria-label attribute of the control HTML element.
bind	IBindFactory	Bind that property.
clearFilter		Remove the filter for that header cell.
clearSort		Remove the alignment of that header cell.
filter		Causes the corresponding header cell to be filtered.
getAriaColIndex	Number	Returns the value of the cell number.
getBindInfo	BindInfo	Returns bind attribute information.
getControlAttr	Object	If a control exists in that cell, returns the value of that control's specific property.
getExpr	String	Returns the expression set in the cell.
getFilter	String[]	Returns the filter condition applied to the header cell.
getSort	Boolean	Returns the ascending / descending order of the sort in that header cell.
getText	Object	Returns the text set in the cell.
isBindable	Boolean	Make sure it is a bindable property.
setExpr		Set an expression in that Cell.
setText		Set text in the cell.
sort		Causes the corresponding header cell to be aligned.
unbind		Unbind that property.

autoFit

type	Boolean
get	Returns the autoFit settings of the header cell.
set	Set autoFit for header cells. Setting information is autofitted to the entire column where the header cell is located.

cellIndex

declaring type	GridColumn
type	Number
readonly	Returns the cellIndex of the cell.

cellProp

declaring type	GridColumn
type	GridCellProp
readonly	Returns the configuration information of the cell.

colIndex

declaring type	GridColumn
type	Number
readonly	Returns the colIndex constituting the cell.

colSpan

declaring type	GridColumn
type	Number
readonly	Returns the colSpan that composes the cell.

columnName

deprecated19.01.21 This function is provided only in detail area.

type	String
readonly	Returns the column name of the DataSet mapped to the cell. (Column names can exist only in cells in the detail area.)

columnType

type	String
readonly	Returns the columnType set in the cell. (ColumnType can exist only in the cells of the Header, Detail, and Group Header areas.)

control

declaring type	GridColumn
type	UIControl
readonly	Returns the controls in that cell.

controlType

declaring type	GridColumn
type	String
readonly	Returns the control type of the control in that cell.

emptyValueSort

type	EMPTYVALUESORT
get	When header sort is used (sortable=true), processing of empty values is returned.
set	Sets the handling of empty values when using header sorting (sortable=true). emptyString (default) : Empty values are sorted together by empty string ("") values in ascending and descending order. nullLast : Empty values are recognized as null and sorted. It is located at the bottom regardless of ascending or descending order.

expr

deprecated19.01.21 This function is provided only in the footer area.

type	String
get	Returns the expression set in the cell. (footer only)
set	Set an expression in that Cell. (footer only)

fieldLabel

declaring type	GridColumn
type	String
get	Returns the logical field name of the cell.
set	Set the logical field name of the cell. If the fieldLabel of the control placed in the cell is set, the fieldLabel of the control is applied.

filterDialogPosition

type	FilterDialogPosition
get	Returns the location where the filter popup will be deployed.
set	Set the location where the filter popup will be placed.

filterDialogTitle

type	String
get	When the filter function is used (filterable=true), the title of the filter dialog is returned.
set	Set the title of the filter dialog when using the filter function (filterable=true).

filterable

type	Boolean
get	For cells in the header area, returns whether to use the multi-filter function through the column value specified by targetColumnName for the cell.
set	For cells in the header area, set whether to use the multi-filter function through the column value specified by targetColumnName for the cell.

formula

declaring type	GridColumn
type	String
get	Returns the function expression to be expressed in a cell when exporting to Excel.
set	Set the function expression to be expressed in the cell when exporting to Excel. Supported built-in functions: #C(number?) Converts set cell index or current cell index to Excel column name #R(number?) Use the set row index or convert the current row index to an Excel row index

resizable

type	Boolean
get	Returns the resizable settings of the header cell.
set	Sets the resizability of the header cell. Setting information is processed as resizable across the entire column where the header cell is located.

rowIndex

declaring type	GridColumn
type	Number
readonly	Returns the rowIndex constituting the cell.

rowSpan

declaring type	GridColumn
type	Number
readonly	Returns the rowSpan that composes the cell.

sortColumnName

type	#column
get	In the case of a cell in the header area, the column name to be sorted is returned when the cell is clicked. sortColumnName supports single sort and sortable multi sort. Incompatible with the sortable attribute, which is another setting related to sorting in header cells. If both are set, the sortable property takes effect.
set	Set the column name to be sorted when the cell is clicked. sortColumnName supports single sort and sortable multi sort. Incompatible with the sortable attribute, which is another setting related to sorting in header cells. If both are set, the sortable property takes effect.

sortKeyExpression

type	#expression
get	When using header sorting (sortable=true), returns the expression by which to be sorted.
set	When using header sorting (sortable=true), set the criteria to be sorted as an expression. ex) When you want to sort by column2 in a column whose targetColumnName is column1, set to 'column2'.

sortable

type	Boolean
get	In the case of a cell in the header area, it returns whether to use the multi-sort function through the column value specified by targetColumnName in the cell. It is incompatible with the sortColumnName property, which is another setting related to sorting in the header cell. If targetColumnName is specified and sortColumnName is specified in a header cell with sortable set to true, the targetColumnName and sortable properties are applied. If both targetColumnName and sortKeyExpression are specified, sortKeyExpression takes precedence.
set	In the case of a cell in the header area, set whether to use the multi-sort function through the column value specified by targetColumnName in the cell. It is incompatible with the sortColumnName property, which is another setting related to sorting in the header cell. If targetColumnName is specified and sortColumnName is specified in a header cell with sortable set to true, the targetColumnName and sortable properties are applied. If both targetColumnName and sortKeyExpression are specified, sortKeyExpression takes precedence.

style

declaring type	GridColumn
type	GridStyler
readonly	Returns the style settings. cpr.data.UIControl.style Note

targetColumnName

type	#column
get	In the case of a cell in the header area, the target dataset column name of the function is returned when filterable or sortable of the cell is used. If sortKeyExpression is specified, sortKeyExpression takes precedence.
set	In the case of a cell in the header area, when using filterable or sortable of the cell, set the column name of the target dataset for the function. If sortKeyExpression is specified, sortKeyExpression takes precedence.

text

type	StyledString
get	Returns the text set in the cell. (header only)
set	Set text in the cell. (header only)

tooltip

declaring type	GridColumn
type	String
get	Get a cell tooltip.
set	Specifies a cell tooltip. It works on mouse over.

visible

type	Boolean
get	Returns the visible setting of the header cell.
set	Set the visibility of the header cell. Setting information is processed as visible throughout the column where the header cell is located.

ariaLabel(ariaLabel)

declaring typeGridColumn

Applies the entered ariaLabel value to the aria-label attribute of the control HTML element.
Only valid in fieldLabel attribute expressions.
When ariaLabel is used, only the entered ariaLabel value is applied, not including cell location information and text values that are applied by default.

Parameters

name	type		description
ariaLabel	String		ariaLabel to set

return	String	Applied ariaLabel

bind(name)

declaring typeGridColumn

Bind that property.

Parameters

name	type		description
name	String		The attribute name to bind.

return	IBindFactory	Factory showing bind type.

clearFilter()

Remove the filter for that header cell.

clearSort()

Remove the alignment of that header cell.

filter(filterValues)

Causes the corresponding header cell to be filtered.
The filter style of the grid header is applied.
It is managed separately from the filter of the dataset.

Parameters

name	type		description
filterValues	any[]		Value to filter.

getAriaColIndex()

declaring typeGridColumn

Returns the value of the cell number.
If the cell is not visible on the grid, no value is returned. Or you must use wholeRenderingMode.
The getAriaColIndex information is required for accessibility.
If ariaLabelCellPosition is set to false in the default.js setting, cell location information is not included in the grid cell aria-label. Use getAriaColIndex when the user wants to include cell location information as fieldLabel.

return	Number

getBindInfo(name)

declaring typeGridColumn

Returns bind attribute information.

Parameters

name	type		description
name	String		The name of the attribute being bound.

return	BindInfo	BindInfo Properties

getControlAttr(attrName)

If a control exists in that cell, returns the value of that control's specific property.

Parameters

name	type		description
attrName	String		Attribute name.

return	Object	Property Value.

getExpr()

deprecated19.01.21 This function is provided only in the footer area.

Returns the expression set in the cell.
(footer only)

return	String	The expression set in the cell.

getFilter()

Returns the filter condition applied to the header cell.

return	String[]	filter conditional expression.

getSort()

Returns the ascending / descending order of the sort in that header cell.

return	Boolean	Ascending / descending order. (Ascending order: true / Descending order: false)

getText()

Returns the text set in the cell.
(header only)

return	Object	The text set in the cell.

isBindable(name)

declaring typeGridColumn

Make sure it is a bindable property.

Parameters

name	type		description
name	String		Properties to check.

return	Boolean

setExpr(expr)

deprecated19.01.21 This function is provided only in the footer area.

Set an expression in that Cell.
(footer only)

Parameters

name	type		description
expr	String		The expression to set.

setText(text)

Set text in the cell.
(header only)

Parameters

name	type		description
text	String		The text to set.

sort(asc)

Causes the corresponding header cell to be aligned.
The alignment style of the grid header is applied.
It is managed separately from the sort of dataset.

Parameters

name	type		description
ascoptional	Boolean		Ascending / descending order. (true: Ascending / false: Descending) When it is not written, it works in the order that it works in the existing header. If you want a specific sort, you can enter the corresponding asending.

unbind(name)

declaring typeGridColumn

Unbind that property.

Parameters

name	type		description
name	String		Attribute name to unbind.