Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for customize ImageEdit plugin

Hierarchy

  • ImageEditOptions

Index

Properties

Optional borderColor

borderColor: string

Color of resize/rotate border, handle and icon

default

#DB626C

Optional disableCrop

disableCrop: boolean

Whether image crop is disabled. @default false

Optional disableRotate

disableRotate: boolean

Whether image rotate is disabled. @default false

Optional disableSideResize

disableSideResize: boolean

Whether side resizing (single direction resizing) is disabled. @default false

Optional imageSelector

imageSelector: string

Selector of the image that allows editing

default

img

Optional minHeight

minHeight: number

Minimum resize/crop height

default

10

Optional minRotateDeg

minRotateDeg: number

Minimum degree increase/decrease when rotate image. Pressing SHIFT key when rotate will ignore this value and rotate by any degree with mouse moving

default

5

Optional minWidth

minWidth: number

Minimum resize/crop width

default

10

Optional onSelectState

onSelectState: ImageEditOperation[]

Which operations will be executed when image is selected

default

resizeAndRotate

Optional preserveRatio

preserveRatio: boolean

Whether preserve width/height ratio when resize Pressing SHIFT key when resize will for preserve ratio even this value is set to false

default

true

Optional resolveImageSource

resolveImageSource: (src: string) => string

Type declaration

    • (src: string): string
    • Optional callback to resolve an image src into a canvas-safe URL (e.g., a data URL). Use this when the original image source (e.g., cid: protocol URLs) cannot be drawn on a canvas.

      Return undefined to keep the original source.

      If you need to map the edited URL back to the original protocol, handle the editImage event and replace the new src as appropriate.

      Parameters

      • src: string

      Returns string

Generated using TypeDoc