Column API in React Gantt API component

Configures column collection in Gantt.

Properties

allowEditing

boolean

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

Defaults to true

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.

Defaults to true

allowReordering

boolean

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

Defaults to true

allowResizing

boolean

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

Defaults to true

allowSorting

boolean

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

Defaults to true

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.

Defaults to Syncfusion.EJ2.Grids.ClipMode.EllipsisWithTooltip

customAttributes

{ [x: string]: Object }

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

Defaults to null

disableHtmlEncode

boolean

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

Defaults to false

displayAsCheckBox

boolean

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

Defaults to false

edit

IEditCell

Defines the IEditCell object to customize default edit cell.

Defaults to {}

editType

string

Defines the type of component for editing.

Defaults to ‘stringedit’

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.

Defaults to null

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.

Defaults to null

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.

Defaults to null

headerTemplate

string | Function

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

Defaults to null

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.

Defaults to null

headerTextAlign

TextAlign

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

Defaults to Syncfusion.EJ2.Grids.TextAlign.Left

hideAtMedia

string

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

Defaults to null

isPrimaryKey

boolean

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

Defaults to false

maxWidth

string | number

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

Defaults to null

minWidth

string | number

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

Defaults to null

sortComparer

SortComparer | string

Defines the custom sort comparer function.

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.

Defaults to null

textAlign

TextAlign

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

Defaults to Syncfusion.EJ2.Grids.TextAlign.Left

validationRules

Object

Defines rules to validate data before creating and updating.

Defaults to null

valueAccessor

ValueAccessor | string

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

Defaults to null

visible

boolean

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

Defaults to true

width

string | number

Defines the width of the column in pixels or percentage.

Defaults to null