SheetManager

class 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 (`IWebViewer()`) – None engine (`IScEngine()`) – None callbackManager (`ICallbackManager()`) – None disableAutomaticBackgroundSheets (`boolean()`) – None
Return type:	`SheetManager()`

Methods

deactivateSheets

SheetManager.deactivateSheets(triggerCallback, ignoreFitNodes)

Arguments:	triggerCallback (`boolean()`) – ignoreFitNodes (`boolean()`) –
Return type:	Promise <void>

endComparison

SheetManager.endComparison()

Return type:	Promise <void>

get3DNodes

SheetManager.get3DNodes()

Return type:	[NodeId]

getActiveSheetId

SheetManager.getActiveSheetId()

Return type:	NodeId \| null

getBackgroundSelectionEnabled

SheetManager.getBackgroundSelectionEnabled()

Return type:	boolean

getBackgroundSheetEnabled

SheetManager.getBackgroundSheetEnabled()

Return type:	boolean

getSheetBackgroundColor

SheetManager.getSheetBackgroundColor()

Return type:	Color

getSheetColor

SheetManager.getSheetColor()

Return type:	Color

getSheetIds

SheetManager.getSheetIds()

Return type:	[NodeId]

getSheetShadowColor

SheetManager.getSheetShadowColor()

Return type:	Color

isDrawingSheetActive

SheetManager.isDrawingSheetActive()

Return type:	boolean

setActiveSheetId

SheetManager.setActiveSheetId(activeSheetId, isolateNodes, fitNodes)

Arguments:	activeSheetId (NodeId) – isolateNodes (`boolean()`) – fitNodes (`boolean()`) –
Return type:	Promise <void>

setBackgroundSelectionEnabled

SheetManager.setBackgroundSelectionEnabled(enabled)

Arguments:	enabled (`boolean()`) – None
Return type:	Promise <void>

setBackgroundSheetEnabled

SheetManager.setBackgroundSheetEnabled(enabled)

Arguments:	enabled (`boolean()`) – None
Return type:	Promise <void>

setSheetColors

SheetManager.setSheetColors(backgroundColor, sheetColor, sheetShadowColor)

Arguments:	backgroundColor (Color) – sheetColor (Color) – sheetShadowColor (Color) –
Return type:	Promise <void>

startComparison

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

Arguments:	sheetId1 (SheetId) – sheetId2 (SheetId) – config (`ComparisonConfig()`) – optional
Return type:	Promise <void>