Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the section element within a section.

Hierarchy

  • IObjectSectionElement

Index

Properties

Optional attributeAssignmentId

attributeAssignmentId: string

Id of the attribute assignment object. Needed for udpates.

Optional attributeId

attributeId: string

Id of the attribute object. Needed for udpates.

Optional columnNumber

columnNumber: number

Indicates which column of the two column layout will the field be part of.

Optional controllingFieldValue

controllingFieldValue: string

Value of the controlling field for dependent picklist

Optional dataType

dataType: string

Data type of the field's or attribute's value.

excludedPicklistValues

excludedPicklistValues: string

Excluded picklist values of an attribute.

Optional fieldApiName

fieldApiName: string

In case the section element is a field, this property will hold the name of the field on the Salesforce Object.

Optional hasRule

hasRule: boolean

Indicates if the section element has rule.

id

id: string

Id of the SectionElement record.

inputType

inputType: string

Tells what kind of control should be shown to input this field. Can be either of text, number, datepicker, datetimepicker, dropdown, radiobutton, or checkbox fields.

Optional isActiveAssignment

isActiveAssignment: boolean

Indicates if the assignment is active

Optional isDependentPicklist

isDependentPicklist: boolean

If picklist is dependent, this will be true.

Optional isDisabled

isDisabled: boolean

Indicates if the section element should be disabled on the UI.

Optional isRequired

isRequired: boolean

Indicates if the section element is required.

Optional isRuntimeConfigurable

isRuntimeConfigurable: boolean

If this is true, the field/attribute will be configured in CPQ and not in Product Console.

Optional isRuntimeHidden

isRuntimeHidden: boolean

If this is true, attribute will be hidden from CPQ Cart.

Optional isRuntimeReadOnly

isRuntimeReadOnly: boolean

If this is true, attribute will be read-only in CPQ.

label

label: string

label for the element.

Optional lookupObjectName

lookupObjectName: string

Applicable only for Lookup data type. This would be the name of the Salesforce object which needs to be looked up.

objectId

objectId: string

Id of the product.

Optional options

options: { label: string; value: string }[]

In case user needs to pick one or more values (dropdown, radio etc.), this holds the list of possible values.

Optional picklistId

picklistId: string

In case of picklist, this will be hold the picklist id. Needed for update.

Optional refValue

refValue: { Id: string; Name: string }

Object that represents the Id and text of a lookup (REFERENCE) type field.

Type declaration

  • Id: string
  • Name: string

sequenceNumber

sequenceNumber: number

Determines the sequence number of the field in the list of the fields.

type

type: string

Indicates whether the element is an attribute or a field

value

value: string | number | boolean

Value of the element.

Generated using TypeDoc