# Class: MarqueeZoomTool

## Tools. MarqueeZoomTool

Represents a tool for DocumentViewer's built-in marquee zoom.

#### new MarqueeZoomTool(docViewer)

  Creates a new instance of MarqueeZoomTool.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `docViewer` | CoreControls.DocumentViewer | an instance of DocumentViewer.

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `setZoomHandler` | function | Sets the function that takes the current zoom level and returns the next zoom level if a mouse click without drag is performed

### Extends

- Tools.Tool

### Methods

#### contextMenu(e)

  The function called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `e` |  | the event object

  Inherited From:
    - Tools.Tool#contextMenu

#### getDocumentViewer()

  Returns the instance of DocumentViewer for this tool.

  Inherited From:
    - Tools.Tool#getDocumentViewer

  ##### Returns:

  the instance of DocumentViewer for this tool.

  Type
    CoreControls.DocumentViewer

#### getMouseLocation(e)

  Takes an event object from a mouse event and converts the location into window coordinates

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `e` |  | the event object containing mouse coordinates

  Inherited From:
    - Tools.Tool#getMouseLocation

#### keyDown(e)

  The function called when a keyboard key is down.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `e` |  | the event object containing keyboard key data.

  Inherited From:
    - Tools.Tool#keyDown

#### mouseDoubleClick(e)

  The function called when the mouse left button is double clicked.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `e` |  | the event object containing mouse coordinates.

  Inherited From:
    - Tools.Tool#mouseDoubleClick

#### mouseLeftDown(e)

  The function called when the left mouse button is down

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `e` |  | the event object containing mouse coordinates.

  Inherited From:
    - Tools.Tool#mouseLeftDown

#### mouseLeftUp(e)

  The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `e` |  | the event object containing mouse coordinates.

  Inherited From:
    - Tools.Tool#mouseLeftUp

#### mouseMove(e)

  The function called when the mouse moves.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `e` |  | the event object containing mouse coordinates.

  Inherited From:
    - Tools.Tool#mouseMove

#### setName(name)

  Set the name of the tool, which can be accessed by toolObject.name

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `name` | string | name of the tool

  Inherited From:
    - Tools.Tool#setName

#### setStyles(callback)

  Set the style for the tool, which will be applied to annotations drawn afterwards

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` |  | callback function that returns new style object from old style object argument.

  Inherited From:
    - Tools.Tool#setStyles

#### switchIn(oldTool)

  The function called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `oldTool` | Tools.Tool | the Tool class that was previously selected.

  Inherited From:
    - Tools.Tool#switchIn

#### switchOut(newTool)

  The function called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `newTool` | Tools.Tool | the Tool class that was newly selected.

  Inherited From:
    - Tools.Tool#switchOut

#### Search results