Class: ViewportProjectionService
Package-level viewport projection facade.
The service is intentionally global to the package so custom synchronizers can resolve projection behavior without reaching into a rendering engine.
Constructors
new ViewportProjectionService()
new ViewportProjectionService():
ViewportProjectionService
Returns
Methods
clear()
clear():
void
Remove all adapters. Intended for isolated tests and custom bootstrapping.
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:354
get()
get(viewport, request)
get<
TKind>(viewport,request):ProjectionSnapshotForKind<TKind>
Resolve a projection snapshot for the given viewport.
Type Parameters
• TKind extends keyof BuiltInViewportProjectionByKind
Parameters
• viewport: unknown
• request: ProjectionRequestForKind<TKind>
Returns
ProjectionSnapshotForKind<TKind>
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:244
get(viewport, request)
get<
TViewport>(viewport,request?):ProjectionSnapshotForViewport<TViewport>
Type Parameters
• TViewport extends BuiltInProjectionViewport
Parameters
• viewport: TViewport
• request?: ProjectionRequestForViewport<TViewport>
Returns
ProjectionSnapshotForViewport<TViewport>
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:248
get(viewport, request)
get<
TSnapshot>(viewport,request?):TSnapshot
Type Parameters
• TSnapshot extends ProjectionSnapshot<unknown, ProjectionPresentation<DisplayArea>> = ProjectionSnapshot<unknown, ProjectionPresentation<DisplayArea>>
Parameters
• viewport: unknown
• request?: Omit<ProjectionRequest<unknown>, "viewport">
Returns
TSnapshot
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:252
getAdapter()
getAdapter(
viewport,request):RegisteredProjectionAdapter
Find the adapter matching the viewport type and optional projection kind.
Parameters
• viewport: unknown
• request: Omit<ProjectionRequest<unknown>, "viewport"> = {}
Returns
RegisteredProjectionAdapter
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:215
getPresentation()
getPresentation(viewport, request)
getPresentation<
TKind>(viewport,request):ProjectionPresentationForKind<TKind>
Resolve a projection snapshot and convert it to the adapter's public view-presentation shape.
Type Parameters
• TKind extends keyof BuiltInViewportProjectionByKind
Parameters
• viewport: unknown
• request: ProjectionRequestForKind<TKind>
Returns
ProjectionPresentationForKind<TKind>
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:272
getPresentation(viewport, request)
getPresentation<
TViewport>(viewport,request?):ProjectionPresentationForViewport<TViewport>
Type Parameters
• TViewport extends BuiltInProjectionViewport
Parameters
• viewport: TViewport
• request?: ProjectionRequestForViewport<TViewport>
Returns
ProjectionPresentationForViewport<TViewport>
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:276
getPresentation(viewport, request)
getPresentation<
TPresentation>(viewport,request?):TPresentation
Type Parameters
• TPresentation = unknown
Parameters
• viewport: unknown
• request?: Omit<ProjectionRequest<unknown>, "viewport">
Returns
TPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:280
getRegisteredAdapters()
getRegisteredAdapters():
RegisteredProjectionAdapter[]
Return registered adapters in registration order.
Returns
RegisteredProjectionAdapter[]
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:347
register()
register<
TViewState,TPresentation,TSnapshot>(adapter):void
Register or replace an adapter by id.
Type Parameters
• TViewState
• TPresentation
• TSnapshot extends ProjectionSnapshot<TViewState, ProjectionPresentation<unknown>>
Parameters
• adapter: ViewportProjectionAdapter<TViewState, TPresentation, TSnapshot>
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:189
unregister()
unregister(
adapterId):void
Remove an adapter by id.
Parameters
• adapterId: string
Returns
void
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:208
withPresentation()
withPresentation(viewport, presentation, request, options)
withPresentation<
TKind>(viewport,presentation,request,options?):ProjectionViewStateForKind<TKind>
Resolve a projection snapshot and calculate the next semantic view state for the requested presentation patch.
Type Parameters
• TKind extends keyof BuiltInViewportProjectionByKind
Parameters
• viewport: unknown
• presentation: Partial<ProjectionPresentationForKind<TKind>>
• request: ProjectionRequestForKind<TKind>
• options?: ProjectionWriteOptions
Returns
ProjectionViewStateForKind<TKind>
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:305
withPresentation(viewport, presentation, request, options)
withPresentation<
TViewport>(viewport,presentation,request?,options?):ProjectionViewStateForViewport<TViewport>
Type Parameters
• TViewport extends BuiltInProjectionViewport
Parameters
• viewport: TViewport
• presentation: Partial<ProjectionPresentationForViewport<TViewport>>
• request?: ProjectionRequestForViewport<TViewport>
• options?: ProjectionWriteOptions
Returns
ProjectionViewStateForViewport<TViewport>
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:311
withPresentation(viewport, presentation, request, options)
withPresentation<
TViewState,TPresentation>(viewport,presentation,request?,options?):TViewState
Type Parameters
• TViewState = unknown
• TPresentation = unknown
Parameters
• viewport: unknown
• presentation: Partial<TPresentation>
• request?: Omit<ProjectionRequest<unknown>, "viewport">
• options?: ProjectionWriteOptions
Returns
TViewState
Defined in
packages/core/src/RenderingEngine/GenericViewport/viewportProjection.ts:317