Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface DrawingData

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

    Properties

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

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this BaseDrawing embedded document

    author: string

    The _id of the user who created the drawing

    bezierFactor?: number

    An amount of bezier smoothing applied, between 0 and 1

    elevation?: number

    The elevation of the drawing

    fillAlpha?: number

    The opacity of the fill applied to the drawing geometry

    fillColor?: string

    An optional color string with which to fill the drawing geometry

    fillType?: number

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

    flags: DocumentFlags

    An object of optional key/value flags

    fontFamily?: string

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

    fontSize?: number

    The font size used to display text within this drawing

    hidden?: boolean

    Is the drawing currently hidden?

    locked?: boolean

    Is the drawing currently locked?

    name?: string

    An optional name.

    rotation?: number

    The angle of rotation for the drawing figure

    shape: ShapeData

    The geometric shape of the drawing

    sort?: number

    The z-index of this drawing relative to other siblings

    strokeAlpha?: number

    The opacity of the boundary lines of the drawing geometry

    strokeColor?: number

    The color of the boundary lines of the drawing geometry

    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

    textAlpha?: number

    The opacity of text displayed within this drawing

    textColor?: string

    The color of text displayed within this drawing

    texture?: string

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

    x: number

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

    y: number

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

    Settings

    Member Visibility

    On This Page

    Properties