Class BimDrawingPdf

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

Hierarchy (View Summary)

BimDrawingObject
- BimDrawingPdf

Index

Constructors

Properties

_api _drawing _onDisposed drawingChange

Accessors

boundingInfo drawing parentTransformNode visible

Methods

dispose forceUpdate getBackgroundColor page pageCount setBackgroundColor

Constructors

constructor

new BimDrawingPdf(
    api: BimCoreApi,
    _drawingPdf: BimPdf,
    drawingChange: BimChangeBlob,
    onDisposed: (o: BimDrawingObject) => void,
): BimDrawingPdf
Parameters
- api: BimCoreApi
- _drawingPdf: BimPdf
- drawingChange: BimChangeBlob
- onDisposed: (o: BimDrawingObject) => void
Returns BimDrawingPdf
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(): BimPdf
Returns BimPdf
The BimPdf object

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

getBackgroundColor

getBackgroundColor(): Color3
Gets the background color for the current PDF

Returns Color3
The background color as a Color3

page

page(p?: number): Promise<number>
Sets which page of PDF should be rendered or gets the current page.
Parameters
- Optionalp: number
  Number of the page you wish to render, 1 - pageCount.
Returns Promise<number>

pageCount

pageCount(): number
Returns number
The number of pages in the PDF.

setBackgroundColor

setBackgroundColor(color: Color3): void
Sets the background color of the PDF.
Parameters
- color: Color3
  new background color for the PDF.
Returns void