Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EditInterface

Hierarchy

  • EditInterface

Implemented by

Index

Properties

Methods

Properties

app

app: ViewerApplication

The {@link geocortex.essentialsHtmlViewer.ViewerApplication} that this instance belongs to.

Methods

getOptions

onGraphicClick

  • onGraphicClick(graphic: Graphic, info: object): void

  • Fired when a graphic is clicked. Applicable only when the MOVE tool is active.

    Parameters

    • graphic: Graphic

      The clicked graphic.

    • info: object

      An object with the following properties: mapPoint, screenPoint

      • mapPoint: Point
      • screenPoint: ScreenPoint

    Returns void

onGraphicFirstMove

  • onGraphicFirstMove(graphic: Graphic): void

  • Fired when the user begins to move a graphic. Applicable only when the MOVE tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    Returns void

onGraphicMove

  • onGraphicMove(graphic: Graphic, transform: any): void

  • Fired continuously as the graphic moves. Applicable only when the MOVE tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • transform: any

      Represents the linear transformation applied to the graphic.

    Returns void

onGraphicMoveStart

  • onGraphicMoveStart(graphic: Graphic): void

  • Fired when the mouse button is pressed down on the graphic, usually while moving a graphic. Applicable only when the MOVE tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    Returns void

onGraphicMoveStop

  • onGraphicMoveStop(graphic: Graphic, transform: any): void

  • Fired when the mouse button is released, usually after moving the graphic. Applicable only when the MOVE tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • transform: any

      Represents the linear transformation applied to the graphic.

    Returns void

onRotate

  • onRotate(graphic: Graphic, info: any): void

  • Fired continuously as a graphic is rotated.

    Parameters

    • graphic: Graphic

      The rotated graphic.

    • info: any

      The info object has the following properties: transform, angle, around

    Returns void

onRotateFirstMove

  • onRotateFirstMove(graphic: Graphic): void

  • Fired when the user begins to drag a handle to rotate the graphic.

    Parameters

    • graphic: Graphic

      The rotated graphic.

    Returns void

onRotateStart

  • onRotateStart(graphic: Graphic): void

  • Fired when a user clicks on the handle to begin rotating a graphic.

    Parameters

    • graphic: Graphic

      The rotated graphic.

    Returns void

onRotateStop

  • onRotateStop(graphic: Graphic, info: any): void

  • Fired when the mouse button is released from the rotate handle to finish rotating the graphic.

    Parameters

    • graphic: Graphic

      The rotated graphic.

    • info: any

      The info object has the following properties: transform, angle, around

    Returns void

onScale

  • onScale(graphic: Graphic, info: any): void

  • Fired continuously as the graphic is being scaled.

    Parameters

    • graphic: Graphic

      The scaled graphic.

    • info: any

      The info object has the following properties: transform, scaleX, scaleY, around

    Returns void

onScaleFirstMove

  • onScaleFirstMove(graphic: Graphic): void

  • Fired when the user begins to drag a handle to scale the graphic.

    Parameters

    • graphic: Graphic

      The scaled graphic.

    Returns void

onScaleStart

  • onScaleStart(graphic: Graphic): void

  • Fired when a user clicks on the handle to scale or resize a graphic.

    Parameters

    • graphic: Graphic

      The scaled graphic.

    Returns void

onScaleStop

  • onScaleStop(graphic: Graphic, info: any): void

  • Fired when the mouse button is released from the scale handle to finish scaling the graphic.

    Parameters

    • graphic: Graphic

      The scaled graphic.

    • info: any

      The info object has the following properties: transform, scaleX, scaleY, around

    Returns void

onVertexAdd

  • onVertexAdd(graphic: Graphic, vertexInfo: any): void

  • Fired after a new vertex is added to a polyline or polygon or a new point is added to a multipoint. Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    Returns void

onVertexClick

  • onVertexClick(graphic: Graphic, vertexInfo: any): void

  • Fired when the mouse button is clicked on the vertex of a polyline or polygon or a point in a multipoint. Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    Returns void

onVertexDelete

  • onVertexDelete(graphic: Graphic, vertexInfo: any): void

  • Fired after a vertex(polyline, polygon) or point(multipoint) is deleted. Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    Returns void

onVertexFirstMove

  • onVertexFirstMove(graphic: Graphic, vertexInfo: any): void

  • Fired when the user begins to move the vertex of a polyline or polygon or a point of a multipoint. Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    Returns void

onVertexMouseOut

  • onVertexMouseOut(graphic: Graphic, vertexInfo: any): void

  • Fired as the mouse exits a vertex(polyline, polygon) or a point(multipoint). Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    Returns void

onVertexMouseOver

  • onVertexMouseOver(graphic: Graphic, vertexInfo: any): void

  • Fired when the mouse moves over a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    Returns void

onVertexMove

  • onVertexMove(graphic: Graphic, vertexInfo: any, transform: any): void

  • Fired continuously as the user is moving a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    • transform: any

      Represents the linear transformation applied to the graphic.

    Returns void

onVertexMoveStart

  • onVertexMoveStart(graphic: Graphic, vertexInfo: any): void

  • Fired when the mouse button is pressed down on a vertex (polyline, polygon) or point (multipoint). Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    Returns void

onVertexMoveStop

  • onVertexMoveStop(graphic: Graphic, vertexInfo: any, transform: any): void

  • Fired when the mouse button is released from a vertex (polyline, polygon) or point(multipoint). Applicable only when the EDIT_VERTICES tool is active.

    Parameters

    • graphic: Graphic

      The graphic associated with the toolbar.

    • vertexInfo: any

      An object with properties: isGhost, pointIndex, segmentIndex

    • transform: any

      Represents the linear transformation applied to the graphic.

    Returns void

refresh

  • refresh(): void

  • Refreshes the internal state of the toolbar.

    Returns void

resume

  • resume(): void

  • Returns void

suspend

  • suspend(): void

  • Returns void