Nutrient Web SDK
    Preparing search index...

    Type Alias DocumentComparisonConfiguration

    Defines specific configuration options related to the document comparison feature. Passed when calling Instance#setDocumentComparisonMode.

    instance.setDocumentComparisonMode({
      documentA: {
        source: NutrientViewer.DocumentComparisonSourceType.USE_OPEN_DOCUMENT
      },
      documentB: {
        source: NutrientViewer.DocumentComparisonSourceType.USE_FILE_DIALOG
      },
      autoCompare: false
    });
    type DocumentComparisonConfiguration = {
        autoCompare: boolean;
        blendMode?: IBlendMode;
        documentA: DocumentComparisonSource;
        documentB: DocumentComparisonSource;
        strokeColors?: DocumentComparisonStrokeColors;
    }
    Index

    Properties

    autoCompare blendMode? documentA documentB strokeColors?

    Properties

    autoCompare: boolean

    Set to true to perform automatic comparison without manual alignment of both documents. Set to false to manually align them.

    blendMode?: IBlendMode

    Blend mode to be used for overlaying the two source documents when performing document comparison.

    "darken"
    documentA: DocumentComparisonSource

    Settings for the base document used for document comparison.

    documentB: DocumentComparisonSource

    Settings for the second document used for document comparison.

    strokeColors?: DocumentComparisonStrokeColors

    Stroke colors to be used for the base and second documents strokes when overlaid for document comparison.

    { documentA: new NutrientViewer.Color({ r: 245, g: 40, b: 27 }), documentB: new NutrientViewer.Color({ r: 49, g: 193, b: 255 }) }

    Settings

    Member Visibility

    On This Page

    Properties