Interface ImageOptions

interface ImageOptions {
    allowEditing?: boolean;
    direction?: CameraDirection;
    height?: number;
    promptLabelCancel?: string;
    promptLabelHeader?: string;
    promptLabelPhoto?: string;
    promptLabelPicture?: string;
    quality?: number;
    resultType: CameraResultType;
    source?: CameraSource;
    width?: number;
}

Properties

allowEditing? direction? height? promptLabelCancel? promptLabelHeader? promptLabelPhoto? promptLabelPicture? quality? resultType source? width?

Properties

Optional allowEditing

allowEditing?: boolean

Whether to allow editing. Not supported on HarmonyOS system pickers — ignored.

Optional direction

direction?: CameraDirection

Camera direction when source is CAMERA; defaults to Rear

Optional height

height?: number

Target height; aspect ratio is preserved when only one dimension is given

Optional promptLabelCancel

promptLabelCancel?: string

Label of the cancel button. Not supported on HarmonyOS (the ActionMenu is dismissed via back/overlay) — accepted for @capacitor/camera drop-in compatibility, ignored.

Optional promptLabelHeader

promptLabelHeader?: string

ActionSheet title for the PROMPT source (default 'Photo')

Optional promptLabelPhoto

promptLabelPhoto?: string

ActionSheet label for choosing the gallery (default 'From Photos')

Optional promptLabelPicture

promptLabelPicture?: string

ActionSheet label for choosing the camera (default 'Take Picture')

Optional quality

quality?: number

JPEG quality 0-100 (applied when returning base64/dataUrl)

resultType

resultType: CameraResultType

Required: how the data should be returned

Optional source

source?: CameraSource

Source; defaults to CameraSource.Prompt

Optional width

width?: number

Target width; aspect ratio is preserved when only one dimension is given

Settings

Member Visibility

Theme

On This Page

allowEditingdirectionheightpromptLabelCancelpromptLabelHeaderpromptLabelPhotopromptLabelPicturequalityresultTypesourcewidth