Options
All
  • Public
  • Public/Protected
  • All
Menu

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

autoStart

autoStart: boolean

Whether access to the camera should be requested automatically upon page load.

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.

device

device: string

The ID of device to retrieve images

Optional formId

formId?: string

ID of the form to use for AJAX requests.

format

format: ImageFormat

Format of the image file.

height

height: number

Height of the camera viewport in pixels.

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.

jpegQuality

jpegQuality: number

Quality of the image between 0 and 100 when the format is jpeg, default value is 90.

onCameraError

onCameraError: onCameraError

Custom Webcam.js error handler

photoHeight

photoHeight: number

Height of the captured photo in pixels, defaults to height.

photoWidth

photoWidth: number

Width of the captured photo in pixels, defaults to width.

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.

process

process: string

Identifiers of components to process during capture.

update

update: string

Identifiers of components to update during capture.

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

width

width: number

Width of the camera viewport in pixels.

Generated using TypeDoc