Row

Row

Represents a row in a channel customizable element.

Constructor

new Row(fields)

Description:
  • Creates an instance of the Row class.
Source:
Parameters:
Name Type Description
fields Array.<ReadOnlyField> The list of fields in the row

Extends

Methods

addField(field) → {Row}

Description:
  • Adds a field to the row.
Source:
Parameters:
Name Type Description
field ReadOnlyField The field to add.
Returns:
The updated instance of the Row.
Type
Row

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.<ReadOnlyField>}

Description:
  • Gets the fields in the row.
Source:
Returns:
The array of fields.
Type
Array.<ReadOnlyField>

getSelectAction()

Description:
  • Gets the select action of the row.
Source:
Returns:
The select action.

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.

setSelectAction(selectAction)

Description:
  • Sets the select action of the row.
Source:
Parameters:
Name Type Description
selectAction The select action to set.
Returns:
The updated instance of the Row.