BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Type Alias ScreenshotOptions

    type ScreenshotOptions = {
        annotations?: boolean;
        backgroundColor?: Color;
        height?: number;
        includeText?: boolean;
        viewpoint?: ViewPoint;
        width?: number;
    }
    Index

    Properties

    annotations?: boolean

    Draw the template annotations shown (annotation layers, their compact states) over the view. Cards, text labels, icons and image annotations are not drawn; images by URL inside a template stay out. Default false. Not drawn in an offscreen screenshot (width/height or viewpoint)

    backgroundColor?: Color

    Override the default background-color (which is #FFFFFF00, fully transparent)

    height?: number
    includeText?: boolean

    Draw the plan labels shown (2D mode, Viewer3dSettings.planLabels) over the view, under the annotations. Default false. Not drawn in an offscreen screenshot (width/height or viewpoint)

    viewpoint?: ViewPoint

    Render from this viewpoint (measurement frame, metres, as Camera.getViewpoint gives) instead of the current camera

    width?: number

    The image size in pixels, both or neither; default the canvas size. With a size or a viewpoint the viewer renders offscreen and leaves the view on screen, its camera and the camera pose broadcast alone