| layout | title | description | keywords | needGenerateH3Content | needAutoGenerateSidebar | noTitleIndex |
|---|---|---|---|---|---|---|
default-layout |
DSImageEditorView - DynamsoftCameraEnhancer iOS Edition API Reference |
The class DSImageEditorView of DynamsoftCameraEnhancer represents an image editor view, which allows users to add interactable UI elements on the view. |
image editor view, objective-c, swift |
true |
true |
true |
The DSImageEditorView class represents an image editor view, which allows users to add interactable UI elements on the view.
Assembly: DynamsoftCore.xcframework
>- Objective-C >- Swift > >1. ```objc @interface DSImageEditorView : UIView ``` 2. ```swift class ImageEditorView : UIView ```| Attributes | Type | Description |
|---|---|---|
image |
The property stores the original image that displayed on the view in a UIImage. |
|
imageData |
The property stores the original image that displayed on the view in a [ImageData]({{ site.dcv_ios_api }}core/basic-structures/image-data.html). |
|
tipConfig |
DSTipConfig | Set/get the tip configurations. |
tipVisible |
BOOL | Set/get the visibility of tip. |
| Method | Description |
|---|---|
initWithFrame |
Create an instance of DSCameraView. |
getSelectedDrawingItem |
Get the selected DrawingItem. |
getDrawingLayer |
Get the specified DrawingLayer. |
createDrawingLayer |
Create a new DrawingLayer. |
deleteUserDefinedDrawingLayer |
Delete the specified drawing layer. |
clearUserDefinedDrawingLayers |
Clear all the user-defined drawing layers. |
getAllDrawingLayers |
Get all the drawing layers on the view. |
updateTipMessage |
Update the tip message. |
setDrawingItemClickListener |
Set a DrawingItemClickListener to receive callback when DrawingItems on the view are clicked. |
The property stores the original image that displayed on the view in a UIImage.
The property stores the original image that displayed on the view in a [ImageData]({{ site.dcv_ios_api }}core/basic-structures/image-data.html).
Set/get the tip configurations.
>- Objective-C >- Swift > >1. ```objc @property (assign, nonatomic) DSTipConfig * tipConfig; ``` 2. ```swift var tipConfig: DSTipConfig { get set } ```Set/get the visibility of tip.
>- Objective-C >- Swift > >1. ```objc @property (assign, nonatomic) BOOL tipVisible; ``` 2. ```swift var tipConfig: BOOL { get set } ```Create an instance of DSImageEditorView.
>- Objective-C >- Swift > >1. ```objc - (instancetype)initWithFrame:(CGRect)frame; ``` 2. ```swift init(frame: CGRect) ```Parameters
frame: A CGRect value that defines the position of the view.
Return Value
An instance of DSImageEditorView.
Code Snippet
>- Objective-C >- Swift > >1. ```objc DSImageEditorView *editorView = [[DSImageEditorView alloc] initWithFrame:frame]; ``` 2. ```swift let editorView = DSImageEditorView(frame: frame) ```Get the selected DrawingItem.
>- Objective-C >- Swift > >1. ```objc - (nullable DSDrawingItem *)getSelectedDrawingItem; ``` 2. ```swift func getSelectedDrawingItem() -> DSDrawingItem? ```Return Value
The selected DrawingItem.
Code Snippet
>- Objective-C >- Swift > >1. ```objc DSDrawingItem *selectedItem = [editorView getSelectedDrawingItem]; ``` 2. ```swift let selectedItem = editorView.getSelectedDrawingItem() ```Get the specified DrawingLayer.
>- Objective-C >- Swift > >1. ```objc - (DSDrawingLayer *)getDrawingLayer:(NSInteger)layerId; ``` 2. ```swift func getDrawingLayer(_ layerId: Int) -> DSDrawingLayer ```Parameters
layerId: The ID of the layer that you want to get.
Return Value
The object of the targeting layer.
Code Snippet
>- Objective-C >- Swift > >1. ```objc DSDrawingLayer *drawingLayer = [editorView getDrawingLayer:layerId]; ``` 2. ```swift let drawingLayer = editorView.getDrawingLayer(layerId) ```Create a new DrawingLayer.
>- Objective-C >- Swift > >1. ```objc - (DSDrawingLayer *)createDrawingLayer; ``` 2. ```swift func createDrawingLayer() -> DSDrawingLayer ```Return Value
The object of the layer you created.
Code Snippet
>- Objective-C >- Swift > >1. ```objc DSDrawingLayer *drawingLayer = [editorView createDrawingLayer]; ``` 2. ```swift let drawingLayer = editorView.createDrawingLayer() ```Delete the specified drawing layer.
>- Objective-C >- Swift > >1. ```objc - (void)deleteUserDefinedDrawingLayer:(NSInteger)layerId; ``` 2. ```swift func deleteUserDefinedDrawingLayer(_ layerId: Int) ```Parameters
layerId: The ID of the layer that you want to delete.
Code Snippet
>- Objective-C >- Swift > >1. ```objc [editorView deleteUserDefinedDrawingLayer:layerId]; ``` 2. ```swift editorView.deleteUserDefinedDrawingLayer(layerId) ```Clear all the user-defined drawing layers.
>- Objective-C >- Swift > >1. ```objc - (void)clearUserDefinedDrawingLayers; ``` 2. ```swift func clearUserDefinedDrawingLayers() ```Get all the drawing layers on the view.
>- Objective-C >- Swift > >1. ```objc - (NSArray*)getAllDrawingLayers; ``` 2. ```swift func getAllDrawingLayers() -> [DrawingLayer] ```Return Value
All the drawing layers. The return value includes both system drawing layers and user defined drawing layers.
Code Snippet
>- Objective-C >- Swift > >1. ```objc NSArray *drawingLayers = [editorView getAllDrawingLayers]; ``` 2. ```swift let drawingLayers = editorView.getAllDrawingLayers() ```Update the tip message.
>- Objective-C >- Swift > >1. ```objc - (void)updateTipMessage:(NSString *)tipMessage; ``` 2. ```swift func updateTipMessage(_ tipMessage: String) ```Parameters
tipMessage: The new message that you want to display.
Code Snippet
>- Objective-C >- Swift > >1. ```objc [editorView updateTipMessage:tipMessage]; ``` 2. ```swift editorView.updateTipMessage(tipMessage) ```Set a DrawingItemClickListener to receive callback when DrawingItems on the view are clicked.
Parameters
clickListener: A protocol instance of DrawingItemClickListener.