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 first item.

autoPlay

autoPlay: boolean

Items are displayed with a slideshow in autoPlay mode.

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.

changeItemOnIndicatorHover

changeItemOnIndicatorHover: boolean

When enabled, item is changed on indicator item's hover.

circular

circular: boolean

Defines if scrolling would be infinite.

closeIcon

closeIcon: string

Close icon on fullscreen mode.

Optional formId

formId?: string

ID of the form to use for AJAX requests.

fullScreen

fullScreen: boolean

Whether to display the component on fullscreen.

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.

indicatorsPosition

indicatorsPosition: string

Position of indicators. Valid values are "bottom", "top", "left" and "right".

numVisible

numVisible: number

Number of items per page.

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.

responsiveOptions

responsiveOptions: { breakpoint: string; numVisible: number }[]

A model of options for responsive design.

showCaption

showCaption: boolean

Whether to display caption container.

showIndicators

showIndicators: boolean

Whether to display indicator container.

showIndicatorsOnItem

showIndicatorsOnItem: boolean

When enabled, indicator container is displayed on item container.

showItemNavigators

showItemNavigators: boolean

Whether to display navigation buttons in item container.

showItemNavigatorsOnHover

showItemNavigatorsOnHover: boolean

Whether to display navigation buttons on item container's hover.

showThumbnailNavigators

showThumbnailNavigators: boolean

Whether to display navigation buttons in thumbnail container.

showThumbnails

showThumbnails: boolean

Whether to display thumbnail container.

thumbnailsPosition

thumbnailsPosition: string

Position of thumbnails. Valid values are "bottom", "top", "left" and "right".

transitionInterval

transitionInterval: number

Time in milliseconds to scroll items.

verticalViewPortHeight

verticalViewPortHeight: string

Height of the viewport in vertical layout.

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