Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the diagram widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.

Hierarchy

Index

Properties

behaviors

behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

connectionOverlays

connectionOverlays: OverlaySpec[]

Overlays for the connections (arrows, labels, etc.)

connections

connections: { uuids: string[] }[]

List of initial connections to be established between nodes.

connectionsDetachable

connectionsDetachable: boolean

Whether connections can be severed by the user.

containment

containment: string

Constrains dragging to within the bounds of the specified element or region.

defaultConnector

defaultConnector: ConnectorSpec

Connector (straight lines, bezier curves, etc.) to use by default.

endPoints

endPoints: (EndpointOptions & { element: ElementGroupRef })[]

A list of endpoints (ports) of all diagram nodes.

Optional formId

formId?: string

ID of the form to use for AJAX requests.

hoverPaintStyle

hoverPaintStyle: PaintStyle

Paint style to use when hovering.

id

id: string | string[]

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

maxConnections

maxConnections: number

Maximum number of allowed connections (per node).

paintStyle

paintStyle: PaintStyle

Paint style to use when not hovering.

postConstruct

postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

postRefresh

postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

preDestroy

preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

widgetVar

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Generated using TypeDoc