mxGuide | mxGraph Typescript Declarations

Hierarchy

mxGuide

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new mxGuide(graph: mxGraph, states: (mxCellState | mxPoint)[]): mxGuide

- Defined in util/mxGuide.d.ts:2
Parameters
- graph: mxGraph
- states: (mxCellState | mxPoint)[]
Returns mxGuide

Properties

graph

graph: mxGraph

Variable: graph

Reference to the enclosing instance.

guideX

guideX: mxShape

Variable: vertical

Holds the for the horizontal guide.

guideY

guideY: mxShape

Variable: vertical

Holds the for the vertical guide.

horizontal

horizontal: boolean

Variable: horizontal

Specifies if horizontal guides are enabled. Default is true.

states

states: mxCellState[]

Variable: states

Contains the that are used for alignment.

vertical

vertical: boolean

Variable: vertical

Specifies if vertical guides are enabled. Default is true.

Methods

createGuideShape

createGuideShape(horizontal: boolean): mxPolyline

- Defined in util/mxGuide.d.ts:80
Function: createGuideShape

Returns the mxShape to be used for painting the respective guide. This implementation returns a new, dashed and crisp using <mxConstants.GUIDE_COLOR> and <mxConstants.GUIDE_STROKEWIDTH> as the format.

Parameters:

horizontal - Boolean that specifies which guide should be created.

Parameters
- horizontal: boolean
Returns mxPolyline

destroy

destroy(): void

- Defined in util/mxGuide.d.ts:115
Function: destroy

Destroys all resources that this object uses.

Returns void

getGuideColor

getGuideColor(state: mxCellState, horizontal: any): string

- Defined in util/mxGuide.d.ts:94
Function: hide

Hides all current guides.

Parameters
- state: mxCellState
- horizontal: any
Returns string

getGuideTolerance

getGuideTolerance(): number

- Defined in util/mxGuide.d.ts:67
Function: getGuideTolerance

Returns the tolerance for the guides. Default value is gridSize / 2.

Returns number

hide

hide(): void

- Defined in util/mxGuide.d.ts:101
Function: hide

Hides all current guides.

Returns void

isEnabledForEvent

isEnabledForEvent(evt: Event): boolean

- Defined in util/mxGuide.d.ts:60
Function: isEnabledForEvent

Returns true if the guide should be enabled for the given native event. This implementation always returns true.

Parameters
- evt: Event
Returns boolean

isStateIgnored

isStateIgnored(state: mxCellState): boolean

- Defined in util/mxGuide.d.ts:121
Returns true if the given state should be ignored.

Parameters
- state: mxCellState
Returns boolean

move

move(bounds: mxRectangle, delta: mxPoint, gridEnabled: boolean, clone: boolean): mxPoint

- Defined in util/mxGuide.d.ts:87
Function: move

Moves the by the given and returnt the snapped point.

Parameters
- bounds: mxRectangle
- delta: mxPoint
- gridEnabled: boolean
- clone: boolean
Returns mxPoint

setStates

setStates(states: mxCellState[]): void

- Defined in util/mxGuide.d.ts:52
Function: setStates

Sets the that should be used for alignment.

Parameters
- states: mxCellState[]
Returns void

setVisible

setVisible(visible: boolean): void

- Defined in util/mxGuide.d.ts:108
Function: setVisible

Shows or hides the current guides.

Parameters
- visible: boolean
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graph: mxGraph

states: (mxCellState | mxPoint)[]

Returns mxGuide

Properties

graph

guideX

guideY

horizontal

states

vertical

Methods

createGuideShape

Parameters

horizontal: boolean

Returns mxPolyline

destroy

Returns void

getGuideColor

Parameters

state: mxCellState

horizontal: any

Returns string

getGuideTolerance

Returns number

hide

Returns void

isEnabledForEvent

Parameters

evt: Event

Returns boolean

isStateIgnored

Parameters

state: mxCellState

Returns boolean

move

Parameters

bounds: mxRectangle

delta: mxPoint

gridEnabled: boolean

clone: boolean

Returns mxPoint

setStates

Parameters

states: mxCellState[]

Returns void

setVisible

Parameters

visible: boolean

Returns void