Class DrawingStyleManager

The DrawingStyleManager class serves as a centralized repository and management system for DrawingStyle objects within an application. It is designed to streamline the process of creating, retrieving, updating, and maintaining a consistent set of drawing styles that can be applied to DrawingItem objects.

createDrawingStyle

Generates a new DrawingStyle object, providing its unique ID. The ID starts from 1024 and increases in a sequential order.

static createDrawingStyle(styleDefinition: DrawingStyle): number; 

Parameters

styleDefinition: the properties and values defining the drawing style.

Return value

The unique ID of the newly created DrawingStyle object.

Code Snippet

let styleID = Dynamsoft.DCE.DrawingStyleManager.createDrawingStyle({
    lineWidth: 4,
    fillStyle: " rgba(73, 173, 245, 0.8)",
    strokeStyle: " rgba(73, 173, 245, 1)",
    paintMode: "fill",
    fontSize: 50,
    fontFamily: "sans-serif"
});

See also

DrawingStyle

getDrawingStyle

Retrieves a specific DrawingStyle object using its ID.

A set of predefined DrawingStyle objects are included by default which are specifically designed for use with Dynamsoft products. Read more on Predefined DrawingStyle object

static getDrawingStyle(drawingStyleId: number): DrawingStyle; 

Parameters

drawingStyleId: the unique ID of the DrawingStyle to update.

Return value

The DrawingStyle object associated with the given ID.

Code Snippet

// Update `drawingStyleId` to a valid identifier available at runtime.
let drawingStyle = Dynamsoft.DCE.DrawingStyleManager.getDrawingStyle(Dynamsoft.DCE.DrawingStyleManager.STYLE_BLUE_STROKE);

See also

DrawingStyle

getAllDrawingStyles

Fetches a collection of all available DrawingStyle objects.

static getAllDrawingStyles(): Array<DrawingStyle>; 

Return value

An array of DrawingStyle objects.

Code Snippet

let drawingStyles = Dynamsoft.DCE.DrawingStyleManager.getAllDrawingStyles();

See also

DrawingStyle

updateDrawingStyle

Modifies an identified DrawingStyle object by its ID. You can update all properties of the DrawingStyle or you can update just a few of them. Check the code snippets for more information.

Modifications are immediately effective for drawing items that are added to the layer moving forward. Additionally, existing items on the layer will be updated upon the addition of a new item. To apply updates to all existing items without the necessity of adding a new one, it’s recommended to use the renderAll() method of the DrawingLayer object.

static updateDrawingStyle(drawingStyleId: number, styleDefinition: DrawingStyle): void; 

Parameters

drawingStyleId: the unique ID of the DrawingStyle to update.

styleDefinition: the new properties and values to update the drawing style with.

Code Snippet

// Change the whole style
Dynamsoft.DCE.DrawingStyleManager.updateDrawingStyle(Dynamsoft.DCE.DrawingStyleManager.STYLE_GREEN_STROKE, {
    fillStyle: "rgba(100, 75, 245, 0.3)",
    fontFamily: "sans-serif",
    fontSize: 25,
    lineWidth: 2,
    paintMode: "strokeAndFill",
    strokeStyle: "rgba(73, 173, 245, 1)"
});
// Only change the fontSize
Dynamsoft.DCE.DrawingStyleManager.updateDrawingStyle(Dynamsoft.DCE.DrawingStyleManager.STYLE_GREEN_STROKE, {
    fontSize: 30
});

See also

DrawingStyle

renderAll()

Special Notice

If you are using Dynamsoft Camera Enhancer with Dynamsoft Barcode Reader, Dynamsoft Label Recognizer or Dynamsoft Document Normalizer, you can use updateDrawingStyle() to update their dedicated styles. These products use the styles of the following IDs:

You can update these styles to apply changes to the DrawingLayers used by these products. For example, the following code changes the style for highlighting found barcodes:

Dynamsoft.DCE.DrawingStyleManager.updateDrawingStyle(Dynamsoft.DCE.DrawingStyleManager.STYLE_ORANGE_STROKE, {
    fillStyle: "rgba(100, 75, 245, 0.3)",
    lineWidth: 5,
    paintMode: "strokeAndFill",
    strokeStyle: "rgba(73, 173, 245, 1)"
});

Predefined DrawingStyle object

Dynamsoft Camera Enhancer includes a set of predefined DrawingStyle objects specifically designed for use with Dynamsoft products.

For more details, check out Built-in DrawingStyles

DDN: Dynamsoft Document Normalizer DBR: Dynamsoft Barcode Reader DLR: Dynamsoft Label Recognizer

Code Snippet

let style = Dynamsoft.DCE.DrawingStyleManager.getDrawingStyle(Dynamsoft.DCE.DrawingStyleManager.STYLE_GREEN_STROKE);
style.lineWidth = 3;
// Update the style
Dynamsoft.DCE.DrawingStyleManager.updateDrawingStyle(Dynamsoft.DCE.DrawingStyleManager.STYLE_GREEN_STROKE, style);