ColumnModel API in React Gantt API component

Interface for a class GanttColumn

Properties

allowEditing

boolean

If allowEditing set to false, then it disables editing of a particular column. By default all columns are editable.

allowFiltering

boolean

If allowFiltering set to false, then it disables filtering option and filter bar element of a particular column. By default all columns are filterable.

allowReordering

boolean

If allowReordering set to false, then it disables reorder of a particular column. By default all columns can be reorder.

allowResizing

boolean

If allowResizing is set to false, it disables resize option of a particular column. By default all the columns can be resized.

allowSorting

boolean

If allowSorting set to false, then it disables sorting option of a particular column. By default all columns are sortable.

clipMode

ClipMode

Defines the cell content’s overflow mode. The available modes are

• Clip - Truncates the cell content when it overflows its area.
• Ellipsis - Displays ellipsis when the cell content overflows its area.
• EllipsisWithTooltip - Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell.

customAttributes

{ [x: string]: Object }

The CSS styles and attributes of the content cells of a particular column can be customized.

disableHtmlEncode

boolean

If disableHtmlEncode is set to true, it encodes the HTML of the header and content cells.

displayAsCheckBox

boolean

If displayAsCheckBox is set to true, it displays the column value as a check box instead of Boolean value.

edit

IEditCell

Defines the IEditCell object to customize default edit cell.

editType

string

Defines the type of component for editing.

field

string

Defines the field name of column which is mapped with mapping name of DataSource. The field name must be a valid JavaScript identifier, the first character must be an alphabet and should not contain spaces and special characters.

filter

IFilter

It is used to customize the default filter options for a specific columns.

• ui - to render custom component for specific column it has following functions.
• ui.create – It is used for creating custom components.
• ui.read - It is used for read the value from the component.
• ui.write - It is used to apply component model as dynamically.

format

string | NumberFormatOptions | DateFormatOptions

It is used to change display value with the given format and does not affect the original data. Gets the format from the user which can be standard or custom number and date formats.

formatter

Object | Function | IGanttCellFormatter

Defines the method which is used to achieve custom formatting from an external function. This function triggers before rendering of each cell.

headerTemplate

string | Function

Defines the header template as string or HTML element ID which is used to add customized element in the column header.

headerText

string

Defines the header text of column which is used to display in column header. If headerText is not defined, then field name value will be assigned to header text.

headerTextAlign

TextAlign

Define the alignment of column header which is used to align the text of column header.

hideAtMedia

string

Column visibility can change based on Media Queries. hideAtMedia accepts only valid Media Queries.

isPrimaryKey

boolean

If isPrimaryKey is set to true, considers this column as the primary key constraint.

maxWidth

string | number

Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.

minWidth

string | number

Defines the minimum width of the column in pixels or percentage.

sortComparer

SortComparer | string

Defines the sort comparer property.

template

string | Function

Defines the column template that renders customized element in each cell of the column. It accepts either template string or HTML element ID.

textAlign

TextAlign

Defines the alignment of the column in both header and content cells.

validationRules

Object

Defines rules to validate data before creating and updating.

valueAccessor

ValueAccessor | string

Defines the method used to apply custom cell values from external function and display this on each cell rendered.

visible

boolean

If visible is set to false, hides the particular column. By default, columns are displayed.

width

string | number

Defines the width of the column in pixels or percentage.