ImageEditorView
Create and Destroy Instances
| Name | Description |
|---|---|
static createInstance() |
Creates an ImageEditorView instance. |
| dispose() | Releases all resources used by the ImageEditorView instance. |
| disposed | A readonly boolean value indicating whether the ImageEditorView instance has been disposed. |
| getUIElement() | Returns the HTML element that is used by the ImageEditorView instance. |
| setUIElement() | Specifies an HTML element for the ImageEditorView instance to use as its UI element. |
Drawing and UI
| Name | Description |
|---|---|
| createDrawingLayer() | Creates a DrawingLayer object and put it in an array of DrawingLayers. |
| getDrawingLayer() | Gets the DrawingLayer specified by its ID. |
| getAllDrawingLayers() | Returns an array of all DrawingLayer objects. |
| deleteUserDefinedDrawingLayer() | Deletes a DrawingLayer object specified by its ID. |
| clearUserDefinedDrawingLayers() | Removes all user-defined DrawingLayers. |
| setTipConfig() | Configures the tip feature. |
| getTipConfig() | Returns the configuration of the tip. |
| setTipVisible() | Sets whether to show the tip. |
| isTipVisible() | Returns whether the tip is visible. |
| updateTipMessage() | Updates the message shown in the tip. |
| getSelectedDrawingItems() | Returns the selected DrawingItem object(s). |
| setVideoFit() | Sets the object-fit CSS property of the video element. |
| getVideoFit() | Returns the value of the object-fit CSS property of the video element. |
| setOriginalImage() | Sets the image to be drawn on the image editor view. |
| getOriginalImage() | Returns the image drawn on the image editor. |
createInstance
Creates an ImageEditorView instance.
dispose
Releases all resources used by the ImageEditorView instance.
disposed
A readonly boolean value indicating whether the ImageEditorView instance has been disposed.
getUIElement
Returns the HTML element that is used by the ImageEditorView instance.
setUIElement
Specifies an HTML element for the ImageEditorView instance to use as its UI element.
createDrawingLayer
Creates a DrawingLayer object and put it in an array of DrawingLayers
getDrawingLayer
Gets the DrawingLayer specified by its ID
getAllDrawingLayers
Returns an array of all DrawingLayer objects
deleteUserDefinedDrawingLayer
Deletes a DrawingLayer object specified by its ID
clearUserDefinedDrawingLayers
Removes all user-defined DrawingLayers
setTipConfig
Configures the tip feature
getTipConfig
Returns the configuration of the tip
setTipVisible
Sets whether to show the tip
isTipVisible
Returns whether the tip is visible
updateTipMessage
Updates the message shown in the tip
getSelectedDrawingItems
Returns the selected DrawingItem object(s).
setVideoFit
Sets the object-fit CSS property of the video element.
getVideoFit
Returns the value of the object-fit CSS property of the video element.
setOriginalImage
Sets the image to be drawn on the image editor view.
getOriginalImage
Returns the image drawn on the image editor.
Yes
No