OverlayType

type OverlayType =
  | 'NoOverlays'
  | 'FullscreenButton'
  | 'ViewOrderButton'
  | 'DataSelectionButton'
  | 'PatientInfo'
  | 'HorizontalScale'
  | 'VerticalScale'
  | 'OrientationMesh'
  | 'Histogram'
  | 'PixelInfo'
  | 'FpsCounter'
  | 'OffscreenIndicator'
  | 'AllOverlays';

Enumeration to select default overlays to add to a view.

• NoOverlays: No overlays are shown.
• FullscreenButton: Button to maximize/minimize the view; requires DisplayAutoLayouter.
• ViewOrderButton: Button to move the view to a different position in the view layout; requires DisplayAutoLayouter.
• DataSelectionButton: Button to select the visible data from the DataModel.
• PatientInfo: Text overlay showing patient information.
• HorizontalScale: Horizontal ruler overlay showing the image scale; only applicable to SliceViews.
• VerticalScale: Vertical ruler overlay showing the image scale; only applicable to SliceViews.
• OrientationMesh: Overlay showing the orientation of the shown data (e.g. in form of a cube).
• Histogram: Shows the intensity distribution of the shown image as histogram; only applicable to SliceViews.
• PixelInfo: Shows image pixel information underneath the mouse pointer; only applicable to SliceViews.
• FpsCounter: Shows an estimate of the frames per second of the renderer.
• OffscreenIndicator: Dynamic overlay showing data that is outside of the current view area; only applicable to SliceViews.
• AllOverlays: Enables all overlays.