Skip to main content

Function: isGenericViewport()

isGenericViewport(viewport): viewport is IGenericViewport

Narrows a viewport to the direct Generic ("next") viewport surface (setDisplaySets / setDisplaySetPresentation / setViewState and the related data/view-state APIs).

Use this instead of instanceof PlanarViewport (or a viewport.type check) when code needs the native-next API rather than the legacy stack/volume method surface. A viewport created with a legacy compatibility adapter is intentionally NOT matched: it exposes the legacy methods, not the direct Generic surface.

Parameters

viewport: unknown

Returns

viewport is IGenericViewport

Defined in

packages/core/src/utilities/viewportCapabilities.ts:119