Skip to main content
Version: 3.11.0-beta.1 (Latest)

Viewport Grid Service

Overview​

This is a new UI service, that handles the grid layout of the viewer.

Events​

There are seven events that get publish in ViewportGridService :

EventDescription
ACTIVE_VIEWPORT_ID_CHANGEDFires the Id of the active viewport is changed
LAYOUT_CHANGEDFires the layout is changed
GRID_STATE_CHANGEDFires when the entire grid state is changed
VIEWPORTS_READYFires when the viewports are ready in the grid

Interface​

For a more detailed look on the options and return values each of these methods is expected to support, [check out it's interface in @ohif/core][interface]

API MemberDescription
setActiveViewportId(viewportId)Sets the active viewport Id in the app
getState()Gets the states of the viewport (see below)
setDisplaySetsForViewport({ viewportId, displaySetInstanceUID })Sets displaySet for viewport based on displaySet Id
setLayout({numCols, numRows, keepExtraViewports})Sets rows and columns. When the total number of viewports decreases, optionally keep the extra/offscreen viewports.
reset()Resets the default states
getNumViewportPanes()Gets the number of visible viewport panes
getLayoutOptionsFromState(gridState)Utility method that produces a ViewportLayoutOptions based on the passed in state
getActiveViewportId()Returns the viewport Id of the active viewport in the grid
getActiveViewportOptionByKey(key)Gets the specified viewport option field (key) for the active viewport

Implementations​

ImplementationConsumer
[ViewportGridProvider]Baked into Dialog Provider

* - Denotes maintained by OHIF

State​

const DEFAULT_STATE = {
  // starting from null, hanging
  // protocol will defined number of rows and cols
  numRows: null,
  numCols: null,
  viewports: [
    /*
     * {
     *    displaySetInstanceUID: string,
     * }
     */
  ],
  activeViewportId: null,
};