Interface DrawingData

interface DrawingData {
    _id: null | string;
    author: string;
    bezierFactor?: number;
    elevation?: number;
    fillAlpha?: number;
    fillColor?: string;
    fillType?: number;
    flags: DocumentFlags;
    fontFamily?: string;
    fontSize?: number;
    hidden?: boolean;
    locked?: boolean;
    rotation?: number;
    shape: ShapeData;
    sort?: number;
    strokeAlpha?: number;
    strokeColor?: number;
    strokeWidth?: number;
    text?: string;
    textAlpha?: number;
    textColor?: string;
    texture?: string;
    x: number;
    y: number;
}

Properties

_id author bezierFactor? elevation? fillAlpha? fillColor? fillType? flags fontFamily? fontSize? hidden? locked? rotation? shape sort? strokeAlpha? strokeColor? strokeWidth? text? textAlpha? textColor? texture? x y

Properties

_id

_id: null | string

The _id which uniquely identifies this BaseDrawing embedded document

author

author: string

The _id of the user who created the drawing

OptionalbezierFactor

bezierFactor?: number

An amount of bezier smoothing applied, between 0 and 1

Optionalelevation

elevation?: number

The elevation of the drawing

OptionalfillAlpha

fillAlpha?: number

The opacity of the fill applied to the drawing geometry

OptionalfillColor

fillColor?: string

An optional color string with which to fill the drawing geometry

OptionalfillType

fillType?: number

The fill type of the drawing shape, a value from CONST.DRAWING_FILL_TYPES

flags

flags: DocumentFlags

An object of optional key/value flags

OptionalfontFamily

fontFamily?: string

The font family used to display text within this drawing, defaults to CONFIG.defaultFontFamily

OptionalfontSize

fontSize?: number

The font size used to display text within this drawing

Optionalhidden

hidden?: boolean

Is the drawing currently hidden?

Optionallocked

locked?: boolean

Is the drawing currently locked?

Optionalrotation

rotation?: number

The angle of rotation for the drawing figure

shape

shape: ShapeData

The geometric shape of the drawing

Optionalsort

sort?: number

The z-index of this drawing relative to other siblings

OptionalstrokeAlpha

strokeAlpha?: number

The opacity of the boundary lines of the drawing geometry

OptionalstrokeColor

strokeColor?: number

The color of the boundary lines of the drawing geometry

OptionalstrokeWidth

strokeWidth?: number

The width in pixels of the boundary lines of the drawing geometry

Optionaltext

text?: string

Optional text which is displayed overtop of the drawing

OptionaltextAlpha

textAlpha?: number

The opacity of text displayed within this drawing

OptionaltextColor

textColor?: string

The color of text displayed within this drawing

Optionaltexture

texture?: string

The path to a tiling image texture used to fill the drawing geometry

x

x: number

The x-coordinate position of the top-left corner of the drawn shape

y

y: number

The y-coordinate position of the top-left corner of the drawn shape

Settings

Member Visibility

On This Page

Properties