DSTextDrawingItem

The DSTextDrawingItem class is a subclass of DSDrawingItem and represents a text drawing item, which can be added to draw texts on the view.

Definition

Assembly: DynamsoftCameraEnhancer.xcframework

Objective-C
Swift

@interface DSTextDrawingItem : DSDrawingItem

```
class TextDrawingItem : DrawingItem
```

Attributes

Attributes	Type	Description
`text`	NSString *	Get the text content of the DSTextDrawingItem.
`topLeftPoint`	CGPoint	Get the top-left point of the DSTextDrawingItem.
`width`	NSInteger	Get the width of the DSTextDrawingItem.
`height`	NSInteger	Get the height of the DSTextDrawingItem.

Methods

Method	Description
`initWithText`	Create an instance of DSTextDrawingItem.
`initWithText:coordinateBase:`	Create an instance of DSTextDrawingItem with coordinate base.

Interited Attributes

The following attributes are inherited from the base class DrawingItem.

Attributes	Type	Description
`drawingStyleId`	NSInteger	The DrawingStyle of the DrawingItem. If a DrawingItem holds a drawingStyleId, it will not use the default style of its layer.
`state`	DSDrawingItemState	The state of the DrawingItem.
`CoordinateBase`	DSCoordinateBase	The coordinate base of the DrawingItem. The coordinate base is image by default.

Interited Methods

The following methods are inherited from the base class DrawingItem.

Method	Description
`getMediaType`	Get the media type of the DrawingItem.
`addNote`	Add a note to the DrawingItem.
`getNote`	Get the specified DSNote.
`hasNote`	Check whether the specified Note exists.
`updateNote`	Update the content of the specified DSNote.
`deleteNote`	Remove the specified DSNote with the specified name.
`getAllNotes`	Get all DSNotes of this DrawingItem.
`clearNotes`	Remove all DSNotes of this DrawingItem.

text

Get the text content of the DSTextDrawingItem.

Objective-C
Swift

@property (nonatomic, copy, readonly) NSString *text;

```
var text: String { get }
```

topLeftPoint

Get the top-left point of the DSTextDrawingItem.

Objective-C
Swift

@property (nonatomic, readonly) CGPoint topLeftPoint;

```
var topLeftPoint: CGPoint { get }
```

width

Get the width of the DSTextDrawingItem.

Objective-C
Swift

@property (nonatomic, readonly) NSInteger width;

```
var width: Int { get }
```

height

Get the height of the DSTextDrawingItem.

Objective-C
Swift

@property (nonatomic, readonly) NSInteger height;

```
var height: Int { get }
```

initWithText

Create an instance of DSTextDrawingItem.

Objective-C
Swift

- (instancetype)initWithText:(NSString *)text
            topLeftPoint:(CGPoint)topLeftPoint
                   width:(NSInteger)width
                  height:(NSInteger)height;

init(text: String, topLeftPoint: CGPoint, width: Int, height: Int)

Parameters

text: The text content of the DSTextDrawingItem.
topLeftPoint: The top-left point of the DSTextDrawingItem.
width: The width of the DSTextDrawingItem.
height: The height of the DSTextDrawingItem.

Return Value

An instance of DSTextDrawingItem.

Code Snippet

Objective-C
Swift

DSTextDrawingItem *item = [[DSTextDrawingItem alloc] initWithText:@"Hello, World!" topLeftPoint:CGPointMake(0, 0) width:100 height:50];

let item = TextDrawingItem(text: "Hello, World!", topLeftPoint: CGPoint(x: 0, y: 0), width: 100, height: 50)

initWithText:coordinateBase:

Create an instance of DSTextDrawingItem with coordinate base.

Objective-C
Swift

- (instancetype)initWithText:(NSString *)text
            topLeftPoint:(CGPoint)topLeftPoint
                   width:(NSInteger)width
                  height:(NSInteger)height
          coordinateBase:(DSCoordinateBase)coordinateBase;

init(text: String, topLeftPoint: CGPoint, width: Int, height: Int, coordinateBase: CoordinateBase)

Parameters

Return Value

An instance of DSTextDrawingItem.

Code Snippet

Objective-C
Swift

DSTextDrawingItem *item = [[DSTextDrawingItem alloc] initWithText:@"Hello, World!" topLeftPoint:CGPointMake(0, 0) width:100 height:50 coordinateBase:DSCoordinateBase_View];

let item = TextDrawingItem(text: "Hello, World!", topLeftPoint: CGPoint(x: 0, y: 0), width: 100, height: 50, coordinateBase: .view)