# Class: DiffOptions

## PDFNet. DiffOptions

#### new DiffOptions()

  Options for PDFNet.PDFDoc.appendVisualDiff

### Methods

#### getAddGroupAnnots()

  Gets the value AddGroupAnnots from the options object Whether we should add an annot layer indicating the difference regions

  ##### Returns:

  a bool, the current value for AddGroupAnnots.

  Type
    boolean

#### getBlendMode()

  Gets the value BlendMode from the options object How the two colors should be blended.

  ##### Returns:

  the current value for BlendMode.

  Type
    number

  ##### Example

      Return value enum:
      <pre>
      PDFNet.GState.BlendMode = {
      	e_bl_compatible : 0
      	e_bl_normal : 1
      	e_bl_multiply : 2
      	e_bl_screen : 3
      	e_bl_difference : 4
      	e_bl_darken : 5
      	e_bl_lighten : 6
      	e_bl_color_dodge : 7
      	e_bl_color_burn : 8
      	e_bl_exclusion : 9
      	e_bl_hard_light : 10
      	e_bl_overlay : 11
      	e_bl_soft_light : 12
      	e_bl_luminosity : 13
      	e_bl_hue : 14
      	e_bl_saturation : 15
      	e_bl_color : 16
      }
      </pre>

#### getColorA()

  Gets the value ColorA from the options object The difference color for the first page.

  ##### Returns:

  a ColorPt, the current value for ColorA.

  Type
    PDFNet.ColorPt

#### getColorB()

  Gets the value ColorB from the options object The difference color for the second page

  ##### Returns:

  a ColorPt, the current value for ColorB.

  Type
    PDFNet.ColorPt

#### setAddGroupAnnots(value)

  Sets the value for AddGroupAnnots in the options object Whether we should add an annot layer indicating the difference regions

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | boolean | the new value for AddGroupAnnots

  ##### Returns:

  this object, for call chaining

  Type
    PDFNet.DiffOptions

#### setBlendMode(value)

  Sets the value for BlendMode in the options object How the two colors should be blended.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | number/enum | the new value for BlendMode
      PDFNet.GState.BlendMode = {
      	e_bl_compatible : 0
      	e_bl_normal : 1
      	e_bl_multiply : 2
      	e_bl_screen : 3
      	e_bl_difference : 4
      	e_bl_darken : 5
      	e_bl_lighten : 6
      	e_bl_color_dodge : 7
      	e_bl_color_burn : 8
      	e_bl_exclusion : 9
      	e_bl_hard_light : 10
      	e_bl_overlay : 11
      	e_bl_soft_light : 12
      	e_bl_luminosity : 13
      	e_bl_hue : 14
      	e_bl_saturation : 15
      	e_bl_color : 16
      }

  ##### Returns:

  this object, for call chaining

  Type
    PDFNet.DiffOptions

#### setColorA(value)

  Sets the value for ColorA in the options object The difference color for the first page.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | PDFNet.ColorPt | the new value for ColorA

  ##### Returns:

  this object, for call chaining

  Type
    PDFNet.DiffOptions

#### setColorB(value)

  Sets the value for ColorB in the options object The difference color for the second page

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | PDFNet.ColorPt | the new value for ColorB

  ##### Returns:

  this object, for call chaining

  Type
    PDFNet.DiffOptions

#### Search results