• Public
  • Public/Protected
  • All

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

aspectRatio?: number

Optional autoCrop

autoCrop?: boolean

Optional autoCropArea

autoCropArea?: number

Optional background

background?: boolean


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 center

center?: boolean

Optional checkCrossOrigin

checkCrossOrigin?: boolean

Optional checkOrientation

checkOrientation?: boolean

Optional cropBoxMovable

cropBoxMovable?: boolean

Optional cropBoxResizable

cropBoxResizable?: boolean

Optional data

Optional dragMode

dragMode?: DragMode

Optional formId

formId?: string

ID of the form to use for AJAX requests.

Optional guides

guides?: boolean

Optional highlight

highlight?: boolean


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.


image: string

ID of the IMAGE element.

Optional initialAspectRatio

initialAspectRatio?: number


initialCoords: [number, number, number, number]

Initial coordinates of the cropper area (x, y, width, height).

Optional minCanvasHeight

minCanvasHeight?: number

Optional minCanvasWidth

minCanvasWidth?: number

Optional minContainerHeight

minContainerHeight?: number

Optional minContainerWidth

minContainerWidth?: number

Optional minCropBoxHeight

minCropBoxHeight?: number

Optional minCropBoxWidth

minCropBoxWidth?: number

Optional modal

modal?: boolean

Optional movable

movable?: boolean


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 preview

preview?: string | HTMLElement | HTMLElement[] | NodeListOf<HTMLElement>

Optional responsive

responsive?: boolean

Optional restore

restore?: boolean

Optional rotatable

rotatable?: boolean

Optional scalable

scalable?: boolean

Optional toggleDragModeOnDblclick

toggleDragModeOnDblclick?: boolean

Optional viewMode

viewMode?: ViewMode

Optional wheelZoomRatio

wheelZoomRatio?: number


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 zoomOnTouch

zoomOnTouch?: boolean

Optional zoomOnWheel

zoomOnWheel?: boolean

Optional zoomable

zoomable?: boolean


Optional crop

Optional cropend

Optional cropmove

Optional cropstart

Optional ready

Optional zoom

Generated using TypeDoc