Options
All
  • Public
  • Public/Protected
  • All
Menu

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

activeIndex

activeIndex: number

Index of the image that is currently displayed.

autoPlay

autoPlay: boolean

Images are displayed in a slideshow in autoPlay.

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.

effect

effect: string

Name of animation to use.

effectOptions

effectOptions: EffectsOptions<HTMLElement>

Options for the transition between two images.

effectSpeed

effectSpeed: number

Duration of the animation in milliseconds.

frameHeight

frameHeight: number

Height of the frames.

frameWidth

frameWidth: number

Width of the frames.

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.

panelHeight

panelHeight: number

Height of the viewport.

panelWidth

panelWidth: number

Width of the viewport.

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.

showCaption

showCaption: boolean

Whether the caption below the image is shown.

showFilmstrip

showFilmstrip: boolean

Whether the strip with all available images is shown.

transitionInterval

transitionInterval: number

Defines interval of slideshow, in milliseconds.

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