SheetManager

class SheetManager()

Constructors

SheetManager.constructor()
SheetManager(viewer: IWebViewer, engine: IScEngine, callbackManager: ICallbackManager, disableAutomaticBackgroundSheets: boolean): SheetManager

Parameters

viewer: IWebViewer

engine: IScEngine

callbackManager: ICallbackManager

disableAutomaticBackgroundSheets: boolean

Returns: SheetManager

Methods

SheetManager.deactivateSheets()
deactivateSheets(triggerCallback: boolean?, ignoreFitNodes: boolean?): Promise

Deactivate sheets and only display 3D content

Parameters

triggerCallback: boolean = true

triggers a “sheetDeactivated” callback if true

ignoreFitNodes: boolean = false

camera will not fit nodes if true

Returns: Promise

promise that resolves when the operation has completed
SheetManager.endComparison()
endComparison(): Promise

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

Returns: Promise

SheetManager.get3DNodes()
get3DNodes(): number[]

Returns Ids of sheet nodes which contain 3D data.

Returns: number[]

SheetManager.getActiveSheetId()
getActiveSheetId(): (None | number)

Returns: (None | number)

gets the id of the current active sheet. null if none has been set.
SheetManager.getBackgroundSelectionEnabled()
getBackgroundSelectionEnabled(): boolean

Gets the current state of the background sheet.

Returns: boolean

true if enabled and false otherwise.
SheetManager.getBackgroundSheetEnabled()
getBackgroundSheetEnabled(): boolean

Gets the current state of the background sheet.

Returns: boolean

true if enabled and false otherwise.
SheetManager.getSheetBackgroundColor()
getSheetBackgroundColor(): Color

Gets the sheet Background Color.

Returns: Color

SheetManager.getSheetColor()
getSheetColor(): Color

Gets the Sheet Color.

Returns: Color

SheetManager.getSheetIds()
getSheetIds(): number[]

Returns: number[]

an array of 2D [[SheetId]]s.
SheetManager.getSheetShadowColor()
getSheetShadowColor(): Color

Gets the Sheet Shadow Color.

Returns: Color

SheetManager.isDrawingSheetActive()
isDrawingSheetActive(): boolean

Returns: boolean

true if a drawing sheet is activated, false otherwise
SheetManager.setActiveSheetId()
setActiveSheetId(activeSheetId: number, isolateNodes: boolean?, fitNodes: boolean?): Promise

Sets the id of the current active sheet

Parameters

activeSheetId: number

id of the sheet which will be activated.

isolateNodes: boolean = true

indicates whether the nodes in the sheet should be isolated

fitNodes: boolean = true

indicates whether a fit world should be performed after isolating the nodes. Note: This parameter has no effect if isolateNodes is false.

Returns: Promise

promise that resolves when the operation has completed
SheetManager.setBackgroundSelectionEnabled()
setBackgroundSelectionEnabled(enabled: boolean): Promise

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.

Parameters

enabled: boolean

Returns: Promise

SheetManager.setBackgroundSheetEnabled()
setBackgroundSheetEnabled(enabled: boolean): Promise

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

Parameters

enabled: boolean

Returns: Promise

SheetManager.setSheetColors()
setSheetColors(backgroundColor: Color, sheetColor: Color, sheetShadowColor: Color): Promise

Sets custom sheet colors.

Parameters

backgroundColor: Color

viewer background color.

sheetColor: Color

sheet background color.

sheetShadowColor: Color

sheet shadow effect color.

Returns: Promise

SheetManager.startComparison()
startComparison(sheetId1: number, sheetId2: number, config: ComparisonConfig): Promise

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

Parameters

sheetId1: number

the drawing sheet to compare against sheetId2

sheetId2: number

the drawing sheet to compare against sheetId1

config: ComparisonConfig

settings controlling the behavior of the comparison

Returns: Promise