DSImageEditorView
The DSImageEditorView
class represents an image editor view, which allows users to add interactable UI elements on the view.
Definition
Assembly: DynamsoftCore.xcframework
- Objective-C
- Swift
@interface DSImageEditorView : UIView
class ImageEditorView : UIView
Attributes
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 . |
|
tipConfig |
DSTipConfig | Set/get the tip configurations. |
tipVisible |
BOOL | Set/get the visibility of tip. |
Methods
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. |
image
The property stores the original image that displayed on the view in a UIImage
.
- Objective-C
- Swift
@property (assign, nonatomic) UIImage *image;
var image:UIImage { get, set }
imageData
The property stores the original image that displayed on the view in a ImageData
.
- Objective-C
- Swift
@property (assign, nonatomic) DSImageData *imageData;
var image:DSImageData { get, set }
tipConfig
Set/get the tip configurations.
- Objective-C
- Swift
@property (assign, nonatomic) DSTipConfig * tipConfig;
var tipConfig: DSTipConfig { get set }
tipVisible
Set/get the visibility of tip.
- Objective-C
- Swift
@property (assign, nonatomic) BOOL tipVisible;
var tipConfig: BOOL { get set }
initWithFrame
Create an instance of DSImageEditorView.
- Objective-C
- Swift
- (instancetype)initWithFrame:(CGRect)frame;
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
DSImageEditorView *editorView = [[DSImageEditorView alloc] initWithFrame:frame];
let editorView = DSImageEditorView(frame: frame)
getSelectedDrawingItem
Get the selected DrawingItem.
- Objective-C
- Swift
- (nullable DSDrawingItem *)getSelectedDrawingItem;
func getSelectedDrawingItem() -> DSDrawingItem?
Return Value
The selected DrawingItem.
Code Snippet
- Objective-C
- Swift
DSDrawingItem *selectedItem = [editorView getSelectedDrawingItem];
let selectedItem = editorView.getSelectedDrawingItem()
getDrawingLayer
Get the specified DrawingLayer.
- Objective-C
- Swift
- (DSDrawingLayer *)getDrawingLayer:(NSInteger)layerId;
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
DSDrawingLayer *drawingLayer = [editorView getDrawingLayer:layerId];
let drawingLayer = editorView.getDrawingLayer(layerId)
createDrawingLayer
Create a new DrawingLayer.
- Objective-C
- Swift
- (DSDrawingLayer *)createDrawingLayer;
func createDrawingLayer() -> DSDrawingLayer
Return Value
The object of the layer you created.
Code Snippet
- Objective-C
- Swift
DSDrawingLayer *drawingLayer = [editorView createDrawingLayer];
let drawingLayer = editorView.createDrawingLayer()
deleteUserDefinedDrawingLayer
Delete the specified drawing layer.
- Objective-C
- Swift
- (void)deleteUserDefinedDrawingLayer:(NSInteger)layerId;
func deleteUserDefinedDrawingLayer(_ layerId: Int)
Parameters
layerId
: The ID of the layer that you want to delete.
Code Snippet
- Objective-C
- Swift
[editorView deleteUserDefinedDrawingLayer:layerId];
editorView.deleteUserDefinedDrawingLayer(layerId)
clearUserDefinedDrawingLayers
Clear all the user-defined drawing layers.
- Objective-C
- Swift
- (void)clearUserDefinedDrawingLayers;
func clearUserDefinedDrawingLayers()
getAllDrawingLayers
Get all the drawing layers on the view.
- Objective-C
- Swift
- (NSArray<DSDrawingLayer *>*)getAllDrawingLayers;
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
NSArray<DSDrawingLayer *> *drawingLayers = [editorView getAllDrawingLayers];
let drawingLayers = editorView.getAllDrawingLayers()
updateTipMessage
Update the tip message.
- Objective-C
- Swift
- (void)updateTipMessage:(NSString *)tipMessage;
func updateTipMessage(_ tipMessage: String)
Parameters
tipMessage
: The new message that you want to display.
Code Snippet
- Objective-C
- Swift
[editorView updateTipMessage:tipMessage];
editorView.updateTipMessage(tipMessage)
setDrawingItemClickListener
Set a DrawingItemClickListener
to receive callback when DrawingItems
on the view are clicked.
- Objective-C
- Swift
- (void)setDrawingItemClickListener:(id<DSDrawingItemClickListener>)clickListener;
func setDrawingItemClickListener(_ clickListener: DrawingItemClickListener)
Parameters
clickListener
: A protocol instance of DrawingItemClickListener
.