Nutrient Web SDK
    Preparing search index...

    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.

    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]
          }
        }
      })
    });

    NutrientViewer.defaultAnnotationsSidebarContent

    ViewState#sidebarOptions

    type AnnotationsSidebarOptions = {
        includeContent: (AnnotationsUnionClass | Class<NutrientViewer.Comment>)[];
    }
    Index

    Properties

    includeContent

    Properties

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

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

    Settings

    Member Visibility

    On This Page

    Properties