Field

Field

Represents an abstract field.

Constructor

new Field()

Source:

Extends

Methods

deserializeNestedProperties()

Description:
  • Deserialize nested object properties into corresponding class instances
Source:
Inherited From:

getChannelExtensionProperty(channelType, propertyName) → {any}

Description:
  • Get the value of a channel extension property
Source:
Inherited From:
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:
Inherited From:
Returns:
The channel extensions
Type
ChannelExtensions

getId() → {string}

Description:
  • Gets the ID of the field.
Source:
Returns:
The ID of the field.
Type
string

getLabel() → {string}

Description:
  • Gets the label of the field.
Source:
Returns:
The label of the field.
Type
string

getLabelFontSize()

Description:
  • Gets the label font size of the field.
Source:
Returns:
The label font size of the field.

getLabelFontWeight()

Description:
  • Gets the label font weight of the field.
Source:
Returns:
The label font weight of the field.

getMarginTop()

Description:
  • Gets the margin top value of the field.
Source:
Returns:
The margin top value of the field.

setChannelExtensionProperty(channelType, propertyName, propertyValue)

Description:
  • Sets a channel-specific extension property
Source:
Inherited From:
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.

setId(id)

Description:
  • Sets the ID of the field.
Source:
Parameters:
Name Type Description
id string The ID of the field.
Returns:
This Field instance.

setLabel(label)

Description:
  • Sets the label of the field.
Source:
Parameters:
Name Type Description
label string The label of the field.
Returns:
This Field instance.

setLabelFontSize(labelFontSize)

Description:
  • Sets the label font size of the field.
Source:
Parameters:
Name Type Description
labelFontSize The label font size of the field.
Returns:
This Field instance.

setLabelFontWeight(labelFontWeight)

Description:
  • Sets the label font weight of the field.
Source:
Parameters:
Name Type Description
labelFontWeight The label font weight of the field.
Returns:
This Field instance.

setMarginTop(marginTop)

Description:
  • Sets the margin top value of the field.
Source:
Parameters:
Name Type Description
marginTop The margin top value of the field.
Returns:
This Field instance.