BimDrawingPdf

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

Hierarchy

• BimDrawingObject
  • BimDrawingPdf

Index

Constructors

• constructor

Properties

• 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

• Overrides BimDrawingObject.constructor

  Parameters

  • api: BimCoreApi

  • _drawingPdf: BimPdf

  • drawingChange: BimChangeBlob

  • onDisposed: (o: BimDrawingObject) => void

  Returns BimDrawingPdf

Properties

publicreadonlydrawingChange

drawingChange: BimChangeBlob | BimChangeDwg

Inherited from BimDrawingObject.drawingChange

BimChangeDwg or BimChangeBlob that the drawing source is loaded from

Accessors

publicboundingInfo

• get boundingInfo(): BoundingInfo

• Inherited from BimDrawingObject.boundingInfo

  Bounding info for the drawing plane

  ---

  Returns BoundingInfo

publicdrawing

• get drawing(): BimPdf

• ---

  Returns BimPdf

  The BimPdf object

publicparentTransformNode

• get parentTransformNode(): Nullable<TransformNode>

• Inherited from BimDrawingObject.parentTransformNode

  Returns Nullable<TransformNode>

publicvisible

• get visible(): boolean
• set visible(v: boolean): void

• Inherited from BimDrawingObject.visible

  true if the drawing is visible, otherwise false.

  ---

  Returns boolean

• Inherited from BimDrawingObject.visible

  Parameters

  • v: boolean

  Returns void

Methods

publicdispose

• dispose(): void

• Inherited from BimDrawingObject.dispose

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

  ---

  Returns void

publicforceUpdate

• forceUpdate(): Promise<void>

• Inherited from BimDrawingObject.forceUpdate

  Force the drawing to zoom based on the camera position and render.

  ---

  Returns Promise<void>

publicgetBackgroundColor

• getBackgroundColor(): Color3

• Gets the background color for the current PDF

  ---

  Returns Color3

  The background color as a Color3

publicpage

• 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>

publicpageCount

• pageCount(): number

• ---

  Returns number

  The number of pages in the PDF.

publicsetBackgroundColor

• setBackgroundColor(color: Color3): void

• Sets the background color of the PDF.

  ---

  Parameters

  • color: Color3

    new background color for the PDF.

  Returns void