@maxgraph/core
    Preparing search index...

    Class Guide

    Implements the alignment of selection cells to other cells in the graph.

    Index
    constructor
    graph guideX guideY horizontal rounded states tolerance vertical
    createGuideShape destroy getDelta getGuideColor getGuideTolerance hide isEnabledForEvent isStateIgnored move setStates setVisible
    graph: AbstractGraph

    Reference to the enclosing AbstractGraph instance.

    guideX: Shape | null = null

    Holds the Shape for the horizontal guide.

    guideY: Shape | null = null

    Holds the Shape for the vertical guide.

    horizontal: boolean = true

    Specifies if horizontal guides are enabled.

    true
    rounded: boolean = false

    Specifies if rounded coordinates should be used. Default is false.

    states: CellState[] = []

    Contains the CellStates that are used for alignment.

    tolerance: number = 2

    Default tolerance in px if grid is disabled. Default is 2.

    vertical: boolean = true

    Specifies if vertical guides are enabled.

    true

    • Returns the Shape to be used for painting the respective guide. This is a hook for subclassers to return different shapes for the guides.

      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

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

      Parameters

      • gridEnabled: boolean = false

      Returns number

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

      Parameters

      • evt: MouseEvent

      Returns boolean

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

      Parameters

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

      Returns Point

    • Shows or hides the current guides.

      Parameters

      • visible: boolean

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods