SheetManager

class Communicator.SheetManager()

Constructors

constructor()

Methods

deactivateSheets()
endComparison()
get3DNodes()
getActiveSheetId()
getBackgroundSelectionEnabled()
getBackgroundSheetEnabled()
getSheetBackgroundColor()
getSheetColor()
getSheetIds()
getSheetShadowColor()
isDrawingSheetActive()
setActiveSheetId()
setBackgroundSelectionEnabled()
setBackgroundSheetEnabled()
setSheetColors()
startComparison()

Constructors

SheetManager.constructor(viewer, engine, callbackManager, disableAutomaticBackgroundSheets)

Arguments

viewer (WebViewer()) –
engine (ScEngine()) –
callbackManager (CallbackManager()) –
disableAutomaticBackgroundSheets (boolean()) –

Return type

SheetManager()

Methods

deactivateSheets

SheetManager.deactivateSheets([triggerCallback[, ignoreFitNodes]])

Deactivate sheets and only display 3D content

Arguments

triggerCallback (boolean()) – optional triggers a “sheetDeactivated” callback if true
ignoreFitNodes (boolean()) – optional camera will not fit nodes if true

Return type

Promise <void>

Returns

promise that resolves when the operation has completed

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: [NodeId]

getActiveSheetId

SheetManager.getActiveSheetId()

Return type: NodeId | null
Returns: gets the id of the current active sheet. null if none has been set.

getBackgroundSelectionEnabled

SheetManager.getBackgroundSelectionEnabled()

Gets the current state of the background sheet.

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

getBackgroundSheetEnabled

SheetManager.getBackgroundSheetEnabled()

Gets the current state of the background sheet.

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

getSheetBackgroundColor

SheetManager.getSheetBackgroundColor()

Gets the sheet Background Color.

Return type: Color()

getSheetColor

SheetManager.getSheetColor()

Gets the Sheet Color.

Return type: Color()

getSheetIds

SheetManager.getSheetIds()

Return type: [NodeId]
Returns: an array of 2D SheetId

getSheetShadowColor

SheetManager.getSheetShadowColor()

Gets the Sheet Shadow Color.

Return type: Color()

isDrawingSheetActive

SheetManager.isDrawingSheetActive()

Return type: boolean
Returns: true if a drawing sheet is activated, false otherwise

setActiveSheetId

SheetManager.setActiveSheetId(activeSheetId[, isolateNodes[, fitNodes]])

Sets the id of the current active sheet

Arguments

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

Return type

Promise <void>

Returns

promise that resolves when the operation has completed

setBackgroundSelectionEnabled

SheetManager.setBackgroundSelectionEnabled(enabled)

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.

Arguments

enabled (boolean()) –

Return type

Promise <void>

setBackgroundSheetEnabled

SheetManager.setBackgroundSheetEnabled(enabled)

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

Arguments

enabled (boolean()) –

Return type

Promise <void>

setSheetColors

SheetManager.setSheetColors(backgroundColor, sheetColor, sheetShadowColor)

Sets custom sheet colors.

Arguments

backgroundColor (Color()) – viewer background color.
sheetColor (Color()) – sheet background color.
sheetShadowColor (Color()) – sheet shadow effect color.

Return type

Promise <void>

startComparison

SheetManager.startComparison(sheetId1, sheetId2[, config])

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

Arguments

sheetId1 (SheetId) – the drawing sheet to compare against sheetId2
sheetId2 (SheetId) – the drawing sheet to compare against sheetId1
config (ComparisonConfig()) – optional settings controlling the behavior of the comparison

Return type

Promise <void>

See endSheetComparison View.startComparison