Class BimDrawingDwg

Represents a drawing that has been loaded using the DrawingApi class.

Hierarchy (View Summary)

BimDrawingObject
- BimDrawingDwg

Index

Constructors

Properties

_api _drawing _onDisposed drawingChange

Accessors

boundingInfo drawing parentTransformNode visible

Methods

dispose forceUpdate invertBackgroundColor setGrayscale

Constructors

constructor

new BimDrawingDwg(
    api: BimCoreApi,
    _drawingSvg: BimSvg,
    drawingChange: BimChangeDwg,
    onDisposed: (o: BimDrawingObject) => void,
): BimDrawingDwg
Parameters
- api: BimCoreApi
- _drawingSvg: BimSvg
- drawingChange: BimChangeDwg
- onDisposed: (o: BimDrawingObject) => void
Returns BimDrawingDwg
Overrides BimDrawingObject.constructor

Properties

`Protected` `Readonly`_api

_api: BimCoreApi

BimApi

`Protected` `Readonly`_drawing

_drawing: BimDrawing

BimSvg or BimPdf instance

`Protected` `Readonly`_onDisposed

_onDisposed: (o: BimDrawingObject) => void

Callback which is invoked when this.dispose is called-

`Readonly`drawingChange

drawingChange: BimChangeBlob | BimChangeDwg

BimChangeDwg or BimChangeBlob that the drawing source is loaded from

Accessors

boundingInfo

get boundingInfo(): BoundingInfo
Bounding info for the drawing plane

Returns BoundingInfo
Inherited from BimDrawingObject.boundingInfo

drawing

get drawing(): BimSvg
Returns BimSvg

parentTransformNode

get parentTransformNode(): Nullable<TransformNode>
Returns Nullable<TransformNode>
Inherited from BimDrawingObject.parentTransformNode

visible

get visible(): boolean
true if the drawing is visible, otherwise false.

Returns boolean
Inherited from BimDrawingObject.visible
set visible(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from BimDrawingObject.visible

Methods

dispose

dispose(): void
Dispose the drawing (it is unloaded and will not longer be visualized.)

Returns void
Inherited from BimDrawingObject.dispose

forceUpdate

forceUpdate(): Promise<void>
Force the drawing to zoom based on the camera position and render.

Returns Promise<void>
Inherited from BimDrawingObject.forceUpdate

invertBackgroundColor

invertBackgroundColor(invert: boolean): void
Set if a DWG should have inverted background color.
Parameters
- invert: boolean
  true if you wish to render with inverted background color, otherwise false
Returns void

setGrayscale

setGrayscale(grayscale: boolean): void
Set if a DWG should render as grayscale or not.
Parameters
- grayscale: boolean
  true if you wish to render as grayscale, otherwise false
Returns void