SheetManager

class Communicator.SheetManager()

Constructors

constructor()

Methods

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

Constructors

constructor

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

Arguments

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

Return type

Communicator.SheetManager

Methods

deactivateSheets

Communicator.SheetManager.deactivateSheets(triggerCallback, ignoreFitNodes)

Deactivate sheets and only display 3D content

Arguments

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

Return type

Promise[void]

Returns

promise that resolves when the operation has completed

endComparison

Communicator.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

Communicator.SheetManager.get3DNodes()

Returns Ids of sheet nodes which contain 3D data.

Return type: [Communicator.NodeId]

getActiveSheetId

Communicator.SheetManager.getActiveSheetId()

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

getBackgroundSelectionEnabled

Communicator.SheetManager.getBackgroundSelectionEnabled()

Gets the current state of the background sheet.

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

getBackgroundSheetEnabled

Communicator.SheetManager.getBackgroundSheetEnabled()

Gets the current state of the background sheet.

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

getSheetBackgroundColor

Communicator.SheetManager.getSheetBackgroundColor()

Gets the sheet Background Color.

Return type: Communicator.Color

getSheetColor

Communicator.SheetManager.getSheetColor()

Gets the Sheet Color.

Return type: Communicator.Color

getSheetIds

Communicator.SheetManager.getSheetIds()

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

getSheetShadowColor

Communicator.SheetManager.getSheetShadowColor()

Gets the Sheet Shadow Color.

Return type: Communicator.Color

isDrawingSheetActive

Communicator.SheetManager.isDrawingSheetActive()

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

setActiveSheetId

Communicator.SheetManager.setActiveSheetId(activeSheetId, isolateNodes, fitNodes)

Sets the id of the current active sheet

Arguments

activeSheetId (Communicator.NodeId()) – id of the sheet which will be activated.
isolateNodes ({ }()) – indicates whether the nodes in the sheet should be isolated
fitNodes ({ }()) – 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

Communicator.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

Communicator.SheetManager.setBackgroundSheetEnabled(enabled)

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

Arguments

enabled (boolean()) –

Return type

Promise[void]

setSheetColors

Communicator.SheetManager.setSheetColors(backgroundColor, sheetColor, sheetShadowColor)

Sets custom sheet colors.

Arguments

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

Return type

Promise[void]

startComparison

Communicator.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.

Arguments

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

Return type

Promise[void]

See endSheetComparison View.startComparison