OverlayManager

class OverlayManager()

Methods

• addNodes()
• destroy()
• getViewportAnchor()
• getViewportPixelOffsetInCanvas()
• getViewportPixelPosition()
• getViewportPixelSize()
• maxIndex()
• setCamera()
• setViewport()
• setVisibility()

---

Methods

addNodes

OverlayManager.addNodes(index, nodes)

Arguments:

• index (OverlayIndex()) –
• nodes ([NodeId]) –

Return type:

Promise <void>

destroy

OverlayManager.destroy(index)

Arguments:

• index (OverlayIndex()) –

Return type:

Promise <void>

getViewportAnchor

OverlayManager.getViewportAnchor(index)

Arguments:

• index (OverlayIndex()) –

Return type:

OverlayAnchor | null

getViewportPixelOffsetInCanvas

OverlayManager.getViewportPixelOffsetInCanvas(index)

Arguments:

• index (OverlayIndex()) –

Return type:

Point2 | null

getViewportPixelPosition

OverlayManager.getViewportPixelPosition(index)

Arguments:

• index (OverlayIndex()) –

Return type:

Point2 | null

getViewportPixelSize

OverlayManager.getViewportPixelSize(index)

Arguments:

• index (OverlayIndex()) –

Return type:

Point2 | null

maxIndex

OverlayManager.maxIndex()

Return type:OverlayIndex

setCamera

OverlayManager.setCamera(index, camera)

Arguments:

• index (OverlayIndex()) –
• camera (Camera()) –

Return type:

Promise <void>

setViewport

OverlayManager.setViewport(index, anchor, x, xUnit, y, yUnit, width, widthUnit, height, heightUnit)

Arguments:

• index (OverlayIndex()) –
• anchor (OverlayAnchor) –
• x (number()) –
• xUnit (OverlayUnit) –
• y (number()) –
• yUnit (OverlayUnit) –
• width (number()) –
• widthUnit (OverlayUnit) –
• height (number()) –
• heightUnit (OverlayUnit) –

Return type:

Promise <void>

setVisibility

OverlayManager.setVisibility(index, visibility)

Arguments:

• index (OverlayIndex()) –
• visibility (boolean()) –

Return type:

Promise <void>