ReferenceAnnotationsSidebarOptions

Type Alias AnnotationsSidebarOptions

The annotations sidebar options allows to specify options available for the annotations sidebar. Currently, you can define a includeContent array in which you can provide a list of annotation classes to be accepted as part of the annotations sidebar, or also whether to include Comment instances or not. By default, the value of includeContent is NutrientViewer.defaultAnnotationsSidebarContent.

Type Alias

Example

Customizing the annotations sidebar to include only NutrientViewer.Annotations.ImageAnnotation instances

NutrientViewer.load({
  initialViewState: new NutrientViewer.ViewState({
    sidebarOptions: {
      [NutrientViewer.SidebarMode.ANNOTATIONS]: {
        includeContent: [NutrientViewer.Annotations.ImageAnnotation]
      }
    }
  })
});

Default Value

NutrientViewer.defaultAnnotationsSidebarContent

Properties

includeContent

(AnnotationsUnionClass | Class<NutrientViewer.Comment>)[]

Array of annotation classes to be accepted as part of the annotations sidebar