Class: Column

componyx .UI .Grid.Column(properties)

Creates an instance of the Grid Column.

Constructor

new Column(properties)

Parameters:

Name	Type	Description
`properties`	Object	The properties used to initialize the object.

Properties:

Name	Type	Description
`properties.id`	String	Gets or sets the id of the column.
`properties.columnGroupId`	String	Gets or sets the column group id.
`properties.headerText`	String	Gets or sets the header text of the column.
`properties.cssClassHeader`	String	Gets or sets the css class of the header column.
`properties.cssClass`	String	Gets or sets the css class of the column.
`properties.style`	String	Gets or sets the css style of the column header.
`properties.width`	String	Gets or sets the width of the column.
`properties.resizable`	Boolean	Gets or sets a value indicating if the column can be resized (defaults to true).
`properties.checkBox`	Boolean	Gets or sets a value indicating if the column is a checkbox column.
`properties.visible`	Boolean	Gets or sets a value indicating if the column is visible.
`properties.disableSorting`	Boolean	Gets or sets a value indicating if the sorting is disabled for this column.
`properties.disableFilter`	Boolean	Gets or sets a value indicating if the filter is disabled for this column when enableFilterRow is set to true.
`properties.filterMenuOptions`	FilterMenuOptions	Gets or sets one or more FilterMenuOptions options.
`properties.filterMenuSelectedOption`	FilterMenuSelectedOption	Gets or sets which filter-menu option is initially selected.
`properties.filterInputType`	FilterInputTypeOption	Gets or sets one of the FilterInputTypeOption.
`properties.headerTooltipTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	Gets or sets the header tooltip template.
`properties.columnTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	Gets or sets the column template. All item properties can be used in the template as interpolations via '{propertyName}'.
`properties.filterTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	Gets or sets the filter template.
`properties.rangeFilterTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	Gets or sets the range filter template.
`properties.filterButtonId`	String	Gets or sets the id of the filter Button component from which the settings are cloned.
`properties.filterInputId`	String	Gets or sets the id of the UI component (NumericBox, ComboBox, DatePicker, TimePicker, Slider) from which the settings are cloned.

Members

checkBox :Boolean

Gets or sets a value indicating if the column is a checkbox column.

Type:

Boolean

columnGroupId :String|null

Gets or sets the column group id.

Type:

String | null

columnTemplate :HTMLElement|Array.<HTMLElement>|DocumentFragment|String|null

Gets or sets the column template. All item properties can be used in the template as interpolations via '{propertyName}'.

Type:

HTMLElement | Array.<HTMLElement> | DocumentFragment | String | null

cssClass :String|null

Gets or sets the css class of the column.

Type:

String | null

cssClassHeader :String|null

Gets or sets the css class of the header column.

Type:

String | null

disableFilter :Boolean

Gets or sets a value indicating if the filter is disabled for this column when enableFilterRow is set to true.

Type:

Boolean

disableSorting :Boolean

Gets or sets a value indicating if the sorting is disabled for this column.

Type:

Boolean

filterButtonId :String|null

Gets or sets the id of the filter Button component from which the settings are cloned.

Type:

String | null

filterInputId :String|null

Gets or sets the id of the UI component (NumericBox, ComboBox, DatePicker, TimePicker, Slider) from which the settings are cloned.

Type:

String | null

filterInputType :FilterInputTypeOption|null

Gets or sets one of the FilterInputTypeOption.

Type:

FilterInputTypeOption | null

filterMenuOptions :FilterMenuOptions|null

Gets or sets one or more FilterMenuOptions options.

Type:

FilterMenuOptions | null

filterMenuSelectedOption :FilterMenuSelectedOption|null

Gets or sets which filter-menu option is initially selected.

Type:

FilterMenuSelectedOption | null

filterTemplate :HTMLElement|Array.<HTMLElement>|DocumentFragment|String|null

Gets or sets the filter template.

Type:

HTMLElement | Array.<HTMLElement> | DocumentFragment | String | null

headerText :String|null

Gets or sets the header text of the column.

Type:

String | null

headerTooltipTemplate :HTMLElement|Array.<HTMLElement>|DocumentFragment|String|null

Gets or sets the header tooltip template.

Type:

HTMLElement | Array.<HTMLElement> | DocumentFragment | String | null

id :String|null

Gets or sets the id of the column.

Type:

String | null

rangeFilterTemplate :HTMLElement|Array.<HTMLElement>|DocumentFragment|String|null

Gets or sets the range filter template.

Type:

HTMLElement | Array.<HTMLElement> | DocumentFragment | String | null

resizable :Boolean

Gets or sets a value indicating if the column can be resized (defaults to true).

Type:

Boolean

style :String|null

Gets or sets the css style of the column header.

Type:

String | null

visible :Boolean

Gets or sets a value indicating if the column is visible.

Type:

Boolean

width :String|null

Gets or sets the width of the column.

Type:

String | null

View and edit mode

Search & Select

Autocomplete Tags

context attribute

value attribute

html attribute

bind attribute

type attribute

attributes attribute

repeat attribute

repeat-item-id attribute

item-id attribute

filter attribute

view-formatter attribute

data-formatter attribute

else-if attribute

else attribute

has-value attribute

includable attribute

include attribute

load attribute

observe attribute

Component Introduction

pre-render attribute

post-render attribute

update-id attribute

keep attribute

view attribute

Node.js Backend

Appskin Appskinevents

Appskin Menuitem

Base Static Item

Base Static Itemlist

Base Webcomponent

Bindary_modules

Bookmarkspy Bookmarkspyevents

Button Buttonevents

Carousel Carouselevents

Colorbutton Colorbuttonevents

Colorpicker Colorpickerevents

Combobox Comboboxevents

Datapager Datapagerevents

Datepicker Datepickerevents

Dialog Dialogevents

Editor Editorevents

Editor Styleitem

Editor_modules Componyx Ui Editor_modules Symbolpicker

Fileupload Fileuploadevents

Form Buildblock

Form Componentsettings

Form Contentfield

Form Datasource

Form Fieldoption

Form Formevents

Form Serverendpoint

Form Spacerfield

Form Validationsettings

Grid Columngroup

Grid Gridevents

Maskedtextbox Maskedtextboxevents

Menu Menuevents

Numericbox Numericboxevents

Panelbar Panelbarevents

Piechart Piechart Segment

Piechart Piechartevents

Piechart Segment

Slider Sliderevents

Tabstrip Tabstripevents

Tabstrip_modules

Timepicker Timepickerevents

Tooltipmanager Trigger

Validator Validatorevents

ClientActivityMonitor

DataContainer<T>

DataContainer<T>

DataContainer<T>

DataResponse<T>

DataResponse<T>

DataResponse<T>

DataUpdateManager

ReusableAttribute

AppSkinAuthenticationMiddleware

AppSkinAuthenticationOptions

AppSkinAuthenticationRequest

AppSkinAuthenticationResponse

AppSkinAuthenticationResponse AuthenticationStateOption

AppSkinAuthenticationResponse FailureReasonOption

AppSkinMenuItem

AppSkinMenuItem MenuSectionOption

AppSkinMenuItem TileSizeOption

AppSkinSearchMiddleware

AppSkinSearchOptions

Base AjaxResult<T>

Base Attributes

Base ItemList<T>

Base NameValuePair

ComboBoxAjaxResult

FilteredColumn FilterOption

GridColumnFilter

Json LenientEnumConverter

Json Utility DefaultSerializer

KeywordIndexData

MenuItem ColumnDirectionOption

MenuItem ExpandDirectionOption

MenuItem TypeOption

ResourceMiddleware

TabStripItem DecorationOption

TagHelpers RegisterTagHelper

TagHelpers RegisterTagHelper ThemeOption

Base JsonDataSettings

Base JsonDataSettings DefaultSerializer

Base LogicRelation<T>

DAL FluentQuery<T>

DAL SqlColumnOrdinalOption

DAL SqlDelimitedIdentifierOption

DAL SqlLimitOption

DAL SqlTopLimitOption

DataAnnotations ForeignKeyAttribute

DataAnnotations ReadOnlyAttribute

DataAnnotations TableAliasAttribute

CaseInsensitiveDictionary<T>

CaseInsensitiveSortedDictionary<T>

Json IJsonSerializer

Json SystemTextJsonSerializer

PluginLoader<T>

Clientactivitymonitor

Dataupdatemanager

License Agreement