Optional
hiddenFields that are hidden and cannot be seen by the user within the relationships properties panel
Optional
initialRepresents the initial field values used to populate the related object during creation.
Represents the list of reasons that define the purpose or context of the relationship.
Optional
newContains the data for a new page model, if applicable.
Includes a PageModelObjectData
object to represent the model structure.
Callback invoked when a link reason is selected.
The selected link reason.
Optional
onCallback invoked when the related page changes. Triggered by events such as data updates or mode transitions.
The event describing the change, either PageDataChange
or PageModeChange
.
Optional
onCallback invoked when the relationship values are updated. Provides both the current and previous values for comparison.
The updated relationship values.
Optional
previous: Record<string, any>The previous relationship values, if available.
Specifies the user-friendly label of the parent object type.
Defines the identifier of the parent object type that owns the relationship.
Optional
readFields that are read-only and cannot be modified by the user within the relationships properties panel
Optional
relationshipRepresents the current field values of the relationship as key-value pairs.
Optional
selectedRepresents the currently selected item in the relationship, if applicable.
Contains an object with id
and type
fields to identify the selected item.
Optional
setCallback to set the API for the page viewer.
Provides a PageViewerAPI
instance to the component.
The PageViewerAPI
instance.
Defines the display label of the target object type.
Defines the identifier of the target object type that the relationship references.
Defines the bindings for managing relationship details in a component.