Class mxHandle

Implements a single custom handle for vertices.

Hierarchy

mxHandle

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new mxHandle(state: mxCellState, cursor: string, image: mxImage, shape: mxShape): mxHandle

- Defined in handler/mxHandle.d.ts:7
Constructs a new handle for the given state.

memberof

mxHandle

Parameters
- state: mxCellState
  
  mxCellState of the cell to be handled.
- cursor: string
- image: mxImage
- shape: mxShape
Returns mxHandle

Properties

cursor

cursor: string

Specifies the cursor to be used for this handle. Default is 'default'.

ignoreGrid

ignoreGrid: boolean

Default is false.

image

image: mxImage

Specifies the to be used to render the handle. Default is null.

Methods

copyStyle

copyStyle(key: string): void

- Defined in handler/mxHandle.d.ts:52
Sets the cell style with the given name to the corresponding value in .

Parameters
- key: string
Returns void

createShape

createShape(html: any): mxShape

- Defined in handler/mxHandle.d.ts:84
Creates and returns the shape for this handle.

Parameters
- html: any
Returns mxShape

destroy

destroy(): void

- Defined in handler/mxHandle.d.ts:131
Destroys this handle.

Returns void

execute

execute(me: mxMouseEvent): void

- Defined in handler/mxHandle.d.ts:47
Hook for subclassers to execute the handle.

Parameters
- me: mxMouseEvent
Returns void

flipPoint

flipPoint(pt: mxPoint): mxPoint

- Defined in handler/mxHandle.d.ts:110
Flips the given point vertically and/or horizontally.

Parameters
- pt: mxPoint
Returns mxPoint

getPosition

getPosition(bounds: mxRectangle): any

- Defined in handler/mxHandle.d.ts:37
Hook for subclassers to return the current position of the handle.

Parameters
- bounds: mxRectangle
Returns any

getRotation

getRotation(): number

- Defined in handler/mxHandle.d.ts:68
Returns the rotation defined in the style of the cell.

Returns number

getTotalRotation

getTotalRotation(): number

- Defined in handler/mxHandle.d.ts:74
Returns the rotation from the style and the rotation from the direction of the cell.

Returns number

init

init(): void

- Defined in handler/mxHandle.d.ts:79
Creates and initializes the shapes required for this handle.

Returns void

initShape

initShape(html: any): void

- Defined in handler/mxHandle.d.ts:89
Initializes and sets its cursor.

Parameters
- html: any
Returns void

isHtmlRequired

isHtmlRequired(): boolean

- Defined in handler/mxHandle.d.ts:100
Returns true if this handle should be rendered in HTML. This returns true if the text node is in the graph container.

Returns boolean

positionChanged

positionChanged(): void

- Defined in handler/mxHandle.d.ts:63
Should be called after in . This repaints the state using .

Returns void

processEvent

processEvent(me: mxMouseEvent): void

- Defined in handler/mxHandle.d.ts:57
Processes the given and invokes .

Parameters
- me: mxMouseEvent
Returns void

redraw

redraw(): void

- Defined in handler/mxHandle.d.ts:94
Renders the shape for this handle.

Returns void

reset

reset(): void

- Defined in handler/mxHandle.d.ts:126
Resets the state of this handle by setting its visibility to true.

Returns void

rotatePoint

rotatePoint(pt: mxPoint, alpha: boolean): mxPoint

- Defined in handler/mxHandle.d.ts:105
Rotates the point by the given angle.

Parameters
- pt: mxPoint
- alpha: boolean
Returns mxPoint

setPosition

setPosition(bounds: mxRectangle, pt: any, me: any): any

- Defined in handler/mxHandle.d.ts:42
Hooks for subclassers to update the style in the .

Parameters
- bounds: mxRectangle
- pt: any
- me: any
Returns any

setVisible

setVisible(visible: boolean): void

- Defined in handler/mxHandle.d.ts:121
Shows or hides this handle.

Parameters
- visible: boolean
Returns void

snapPoint

snapPoint(pt: mxPoint, ignore: boolean): mxPoint

- Defined in handler/mxHandle.d.ts:116
Snaps the given point to the grid if ignore is false. This modifies the given point in-place and also returns it.

Parameters
- pt: mxPoint
- ignore: boolean
Returns mxPoint

Generated using TypeDoc