Updated the ViewportGridService docs.

OHIF · Mar 29, 2023 · 6f94c7f · 6f94c7f
1 parent cc43b8b
commit 6f94c7f
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/platform/docs/docs/platform/services/ui/viewport-grid-service.md b/platform/docs/docs/platform/services/ui/viewport-grid-service.md
@@ -9,6 +9,15 @@ sidebar_label: Viewport Grid Service
 
 This is a new UI service, that handles the grid layout of the viewer.
 
+## Events
+
+There are seven events that get publish in `ViewportGridService `:
+
+| Event                         | Description                                       |
+| ----------------------------- | --------------------------------------------------|
+| ACTIVE_VIEWPORT_INDEX_CHANGED | Fires the index of the active viewport is changed |
+| LAYOUT_CHANGED                | Fires the layout is changed                       |
+| GRID_STATE_CHANGED            | Fires when the entire grid state is changed       |
 ## Interface
 
 For a more detailed look on the options and return values each of these methods
@@ -19,9 +28,10 @@ is expected to support, [check out it's interface in `@ohif/core`][interface]
 | `setActiveViewportIndex(index)`                                       | Sets the active viewport index in the app           |
 | `getState()`                                                          | Gets the states of the viewport (see below)         |
 | `setDisplaySetsForViewport({ viewportIndex, 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. |
+| `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|
 
 ## Implementations