Nutrient Web SDK

Reference EventsEventNameToHandlerMap

Interface EventNameToHandlerMap

Interface

Properties

annotationNote.hover

(event: AnnotationNoteHoverEvent) => void

annotationNote.press

(event: AnnotationNotePressEvent) => void

annotationPresets.update

(event: AnnotationPresetsUpdateEvent) => void

annotations.blur

(event: AnnotationsBlurEvent) => void

annotations.change

() => void

annotations.copy

(event: AnnotationsCopyEvent) => void

annotations.create

(event: AnnotationsCreateEvent) => void

annotations.cut

(event: AnnotationsCutEvent) => void

annotations.delete

(event: AnnotationsDeleteEvent) => void

annotations.didSave

() => void

annotations.duplicate

(event: AnnotationsDuplicateEvent) => void

annotations.focus

(event: AnnotationsFocusEvent) => void

annotations.load

(event: AnnotationsLoadEvent) => void

annotations.paste

(event: AnnotationsPasteEvent) => void

annotations.press

(event: AnnotationsPressEvent) => void

annotations.transform

(event: AnnotationsTransformEvent) => void

annotations.update

(event: AnnotationsUpdateEvent) => void

annotations.willChange

(event: AnnotationsWillChangeEvent) => void

annotations.willSave

() => void

annotationSelection.change

(event: AnnotationSelectionChangeEvent) => void

bookmarks.change

() => void

bookmarks.create

(event: BookmarksCreateEvent) => void

bookmarks.delete

(event: BookmarksDeleteEvent) => void

bookmarks.didSave

() => void

bookmarks.load

(event: BookmarksLoadEvent) => void

bookmarks.update

(event: BookmarksUpdateEvent) => void

bookmarks.willSave

() => void

comments.change

() => void

comments.create

(event: CommentsCreateEvent) => void

comments.delete

(event: CommentsDeleteEvent) => void

comments.didSave

() => void

comments.load

(event: CommentsLoadEvent) => void

comments.mention

(event: CommentsMentionEvent) => void

comments.update

(event: CommentsUpdateEvent) => void

comments.willSave

() => void

contentEditor.stateChange

(event: ContentEditorStateChange) => void

cropArea.changeStart

(event: CropAreaChangeStartEvent) => void

cropArea.changeStop

(event: CropAreaChangeStopEvent) => void

document.change

(operations?: DocumentChangeEventOperation[]) => void

document.saveStateChange

(event: SaveStateChangeEvent) => void

documentComparisonUI.end

() => void

documentComparisonUI.start

(event: DocumentComparisonConfiguration) => void

formFields.change

() => void

formFields.create

(event: FormFieldsCreateEvent) => void

formFields.delete

(event: FormFieldsDeleteEvent) => void

formFields.didSave

() => void

formFields.load

(event: FormFieldsLoadEvent) => void

formFields.update

(event: FormFieldsUpdateEvent) => void

formFields.willSave

() => void

formFieldValues.didSave

(event: FormFieldValuesDidSaveEvent) => void

formFieldValues.update

(event: FormFieldValuesUpdateEvent) => void

formFieldValues.willSave

() => void

forms.didSubmit

() => void

forms.willSubmit

(event: { preventDefault: () => void }) => void

history.change

(event: HistoryChangeEvent) => void

history.clear

() => void

history.redo

(event: HistoryRedoEvent) => void

history.undo

(event: HistoryUndoEvent) => void

history.willChange

(event: HistoryWillChangeEvent) => void

ink.drawing

(event: InkDrawingEvent) => void

inkSignatures.change

() => void

inkSignatures.create

(
    event:
        | NutrientViewer.Annotations.InkAnnotation
        | NutrientViewer.Annotations.ImageAnnotation,
) => void

inkSignatures.delete

(
    event:
        | NutrientViewer.Annotations.InkAnnotation
        | NutrientViewer.Annotations.ImageAnnotation,
) => void

inkSignatures.update

(event: InkSignatureUpdateEvent) => void

instant.connectedClients.change

(
    clients: NutrientViewer.Immutable.Map<
        string,
        NutrientViewer.InstantClient,
    >,
) => void

page.press

(event: PagePressEvent) => void

page.renderError

(event: PageRenderErrorEvent) => void

search.stateChange

(event: NutrientViewer.SearchState) => void

search.termChange

(event: SearchTermChangeEvent) => void

storedSignatures.change

() => void

storedSignatures.create

(
    event:
        | NutrientViewer.Annotations.InkAnnotation
        | NutrientViewer.Annotations.ImageAnnotation,
) => void

storedSignatures.delete

(
    event:
        | NutrientViewer.Annotations.InkAnnotation
        | NutrientViewer.Annotations.ImageAnnotation,
) => void

storedSignatures.update

(event: StoredSignatureUpdateEvent) => void

textAnnotationEditorState.change

(event: TextAnnotationEditorStateChangeEvent) => void

textLine.press

(event: TextLinePressEvent) => void

textSelection.change

(selection: TextSelection | null) => void

viewState.change

(
previousViewState: NutrientViewer.ViewState,
viewState: NutrientViewer.ViewState,
) => void

viewState.currentPageIndex.change

(event: number) => void

viewState.zoom.change

(event: number) => void