SheetManager

class SheetManager()

Constructors

Methods

Constructors

SheetManager.constructor(viewer, engine, callbackManager, disableAutomaticBackgroundSheets)
Arguments:
  • viewer (IWebViewer()) – None
  • engine (IScEngine()) – None
  • callbackManager (ICallbackManager()) – None
  • disableAutomaticBackgroundSheets (boolean()) – None
Return type:

SheetManager

Methods

deactivateSheets

SheetManager.deactivateSheets(triggerCallback, ignoreFitNodes)
Arguments:
  • triggerCallback (boolean()) – triggers a “sheetDeactivated” callback if true
  • ignoreFitNodes (boolean()) – camera will not fit nodes if true

Deactivate sheets and only display 3D content

Returns:promise that resolves when the operation has completed
Return type:Promise <void>

endComparison

SheetManager.endComparison()

Disables a visual comparison of two drawing sheets enabled by [[startSheetComparison]]. The Promise returned by that function should be waited upon before calling [[endSheetComparison]].

Return type:Promise <void>

get3DNodes

SheetManager.get3DNodes()

Returns Ids of sheet nodes which contain 3D data.

Return type:[number]

getActiveSheetId

SheetManager.getActiveSheetId()
Returns:gets the id of the current active sheet. null if none has been set.
Return type:null | number

getBackgroundSelectionEnabled

SheetManager.getBackgroundSelectionEnabled()

Gets the current state of the background sheet.

Returns:true if enabled and false otherwise.
Return type:boolean

getBackgroundSheetEnabled

SheetManager.getBackgroundSheetEnabled()

Gets the current state of the background sheet.

Returns:true if enabled and false otherwise.
Return type:boolean

getSheetBackgroundColor

SheetManager.getSheetBackgroundColor()

Gets the sheet Background Color.

Return type:Color

getSheetColor

SheetManager.getSheetColor()

Gets the Sheet Color.

Return type:Color

getSheetIds

SheetManager.getSheetIds()
Returns:an array of 2D [[SheetId]]s.
Return type:[number]

getSheetShadowColor

SheetManager.getSheetShadowColor()

Gets the Sheet Shadow Color.

Return type:Color

isDrawingSheetActive

SheetManager.isDrawingSheetActive()
Returns:true if a drawing sheet is activated, false otherwise
Return type:boolean

setActiveSheetId

SheetManager.setActiveSheetId(activeSheetId, isolateNodes, fitNodes)
Arguments:
  • activeSheetId (number()) – id of the sheet which will be activated.
  • isolateNodes (boolean()) – indicates whether the nodes in the sheet should be isolated
  • fitNodes (boolean()) – indicates whether a fit world should be performed after isolating the nodes. Note: This parameter has no effect if isolateNodes is false.

Sets the id of the current active sheet

Returns:promise that resolves when the operation has completed
Return type:Promise <void>

setBackgroundSelectionEnabled

SheetManager.setBackgroundSelectionEnabled(enabled)
Arguments:
  • enabled (boolean()) – None

Sets whether the background for 2D drawings is selectable. By default it is not. 2D drawings have an invisible selection plane with a single face. Note that this setting is unaffected by the background-sheet enable setting.

Return type:Promise <void>

setBackgroundSheetEnabled

SheetManager.setBackgroundSheetEnabled(enabled)
Arguments:
  • enabled (boolean()) – None

Enables or disables the background sheet used for 2D drawings.

Return type:Promise <void>

setSheetColors

SheetManager.setSheetColors(backgroundColor, sheetColor, sheetShadowColor)
Arguments:
  • backgroundColor (Color()) – viewer background color.
  • sheetColor (Color()) – sheet background color.
  • sheetShadowColor (Color()) – sheet shadow effect color.

Sets custom sheet colors.

Return type:Promise <void>

startComparison

SheetManager.startComparison(sheetId1, sheetId2[, config])
Arguments:
  • sheetId1 (number()) – the drawing sheet to compare against sheetId2
  • sheetId2 (number()) – the drawing sheet to compare against sheetId1
  • config (ComparisonConfig()) – optional settings controlling the behavior of the comparison

Enables a visual comparison of two drawing sheets. The nodes specified by sheetId1 are filled with one color, the nodes specified by sheetId2 with another color, and overlapping areas are filled with a third color.

See [[endSheetComparison]], [[View.startComparison]].

Return type:Promise <void>