• Public
  • Public/Protected
  • All

The configuration for the Dashboard 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.




Optional activate

activate?: SortableEvent

Optional appendTo

appendTo?: any

Optional attribute

attribute?: string

Optional axis

axis?: string

Optional beforeStop

beforeStop?: SortableEvent


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.

Optional cancel

cancel?: any

Optional change

change?: SortableEvent

Optional connectWith

connectWith?: any

Optional containment

containment?: any

Optional cursor

cursor?: string

Optional cursorAt

cursorAt?: any

Optional deactivate

deactivate?: SortableEvent

Optional delay

delay?: number

Optional disabled

disabled?: boolean

Optional distance

distance?: number

Optional dropOnEmpty

dropOnEmpty?: boolean

Optional forceHelperSize

forceHelperSize?: boolean

Optional forcePlaceholderSize

forcePlaceholderSize?: boolean

Optional formId

formId?: string

ID of the form to use for AJAX requests.

Optional grid

grid?: number[]

Optional handle

handle?: any

Optional helper

helper?: string | ((event: JQueryEventObject, element: Sortable) => Element)


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.

Optional items

items?: any

Optional opacity

opacity?: number

Optional out

Optional over

Optional placeholder

placeholder?: string


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: 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: 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.

Optional receive

receive?: SortableEvent

Optional remove

remove?: SortableEvent

Optional revert

revert?: any

Optional scroll

scroll?: boolean

Optional scrollSensitivity

scrollSensitivity?: number

Optional scrollSpeed

scrollSpeed?: number

Optional sort

Optional start

Optional stop

Optional tolerance

tolerance?: string

Optional update

update?: SortableEvent


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").

Optional zIndex

zIndex?: number

Generated using TypeDoc