Constructor
new Column(fieldsopt)
- Description:
- Creates an instance of the Column class.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
fields |
Array.<Field> |
<optional> |
The list of fields in the column. |
Extends
Methods
addField(field) → {Column}
- Description:
- Adds a field to the column.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
field |
Field | The field to add. |
Returns:
The updated instance of the Column.
- Type
- Column
deserializeNestedProperties()
- Description:
- Deserialize nested object properties into corresponding class instances
- Source:
- Overrides:
getChannelExtensionProperty(channelType, propertyName) → {any}
- Description:
- Get the value of a channel extension property
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
channelType |
ChannelType | The channel type. |
propertyName |
string | The name of the property. |
Returns:
The property value
- Type
- any
getChannelExtensions() → {ChannelExtensions}
- Description:
- Gets the channel extensions
- Source:
- Overrides:
Returns:
The channel extensions
- Type
- ChannelExtensions
getFields() → {Array.<Field>}
- Description:
- Gets the list of fields in the column.
- Source:
Returns:
The list of fields in the column.
- Type
- Array.<Field>
getId() → {string}
- Description:
- Gets the ID of the column.
- Source:
Returns:
The ID of the column.
- Type
- string
getVerticalAlignment() → {VerticalAlignment}
- Description:
- Gets the vertical alignment of the column.
- Source:
Returns:
The alignment.
- Type
- VerticalAlignment
getWidth() → {ColumnWidth}
- Description:
- Gets the width of the column.
- Source:
Returns:
The width.
- Type
- ColumnWidth
setChannelExtensionProperty(channelType, propertyName, propertyValue)
- Description:
- Sets a channel-specific extension property
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
channelType |
ChannelType | The channel type. |
propertyName |
string | The name of the property. |
propertyValue |
any | The value of the property. |
Returns:
The current instance of this class.
setFields(fields) → {Column}
- Description:
- Sets the fields of the column.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
fields |
Array.<Field> | The fields to set. |
Returns:
The updated instance of the Column.
- Type
- Column
setId(id) → {Column}
- Description:
- Sets the ID of the column.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID to set. |
Returns:
The updated instance of the Column.
- Type
- Column
setVerticalAlignment(verticalAlignment) → {Column}
- Description:
- Sets the vertical alignment of the column.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
verticalAlignment |
string | The alignment to set. |
Returns:
The updated instance of the Column.
- Type
- Column
setWidth(width) → {Column}
- Description:
- Sets the width of the column.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
string | The width to set. |
Returns:
The updated instance of the Column.
- Type
- Column