ViewerDrawingProcessOptions

Interface ViewerDrawingProcessOptions

Contains options for the ViewerDrawingAPI.leaveDrawingMode method. The options are used to configure the result of the processing.

interface ViewerDrawingProcessOptions {
    brushPrimitiveType?: "triangleStrip";
    penPrimitiveType?: "triangleStrip" | "lineStrip";
    shapePrimitiveType?: "triangleStrip" | "lineStrip";
    subDivisions?: number;
    thumbnail?: boolean;
    thumbnailHeight?: number;
    thumbnailWidth?: number;
}

Properties

brushPrimitiveType? penPrimitiveType? shapePrimitiveType? subDivisions? thumbnail? thumbnailHeight? thumbnailWidth?

Properties

OptionalbrushPrimitiveType

brushPrimitiveType?: "triangleStrip"

Specifies the output primitive type of the brush-drawings.

Default

"triangleStrip"

OptionalpenPrimitiveType

penPrimitiveType?: "triangleStrip" | "lineStrip"

Specifies the output primitive type of the pen-drawings.

Default

"triangleStrip"

OptionalshapePrimitiveType

shapePrimitiveType?: "triangleStrip" | "lineStrip"

Specifies the output primitive type of the shape-drawings.

Default

"triangleStrip"

OptionalsubDivisions

subDivisions?: number

Specifies the number of points to render shapes with when using the "lineStrip" primitive type.

Default

50

Optionalthumbnail

thumbnail?: boolean

Specifies if the result contains a thumbnail of the drawing.

Default

true

OptionalthumbnailHeight

thumbnailHeight?: number

Specifies the height of the thumbnail. If the thumbnail height or width is not set, the current viewer size is used.

Default

undefined

OptionalthumbnailWidth

thumbnailWidth?: number

Specifies the width of the thumbnail. If the thumbnail height or width is not set, the current viewer size is used.

Default

undefined


Was this page helpful? Please leave a thumbs up or down.