Class Guide

constructor

• new Guide(graph: Graph, states: CellState[]): Guide

  Parameters

  • graph: Graph
  • states: CellState[]

  Returns Guide

graph

guideX

guideY

horizontal

rounded

states

tolerance

vertical

createGuideShape

• createGuideShape(horizontal?: boolean): PolylineShape

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

  Parameters

  • horizontal: boolean = false

    Boolean that specifies which guide should be created.

  Returns PolylineShape

destroy

• destroy(): void

  Destroys all resources that this object uses.

  Returns void

getDelta

• getDelta(
      bounds: Rectangle,
      stateX?: null | CellState,
      dx: number,
      stateY?: null | CellState,
      dy: number,
  ): Point

  Rounds to pixels for virtual states (eg. page guides)

  Parameters

  • bounds: Rectangle
  • stateX: null | CellState = null
  • dx: number
  • stateY: null | CellState = null
  • dy: number

  Returns Point

getGuideColor

• getGuideColor(state: CellState, horizontal: boolean): string

  Hides all current guides.

  Parameters

  • state: CellState
  • horizontal: boolean

  Returns string

getGuideTolerance

• getGuideTolerance(gridEnabled?: boolean): number

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

  Parameters

  • gridEnabled: boolean = false

  Returns number

hide

• hide(): void

  Hides all current guides.

  Returns void

isEnabledForEvent

• isEnabledForEvent(evt: MouseEvent): boolean

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

  Parameters

  • evt: MouseEvent

  Returns boolean

isStateIgnored

• isStateIgnored(state: CellState): boolean

  Returns true if the given state should be ignored.

  Parameters

  • state: CellState

  Returns boolean

move

• move(
      bounds?: null | Rectangle,
      delta: Point,
      gridEnabled?: boolean,
      clone?: boolean,
  ): Point

  Moves the by the given Point and returnt the snapped point.

  Parameters

  • bounds: null | Rectangle = null
  • delta: Point
  • gridEnabled: boolean = false
  • clone: boolean = false

  Returns Point

setStates

• setStates(states: CellState[]): void

  Sets the CellStates that should be used for alignment.

  Parameters

  • states: CellState[]

  Returns void

setVisible

• setVisible(visible: boolean): void

  Shows or hides the current guides.

  Parameters

  • visible: boolean

  Returns void