Interface SnapGuideResult

Snap result enriched with renderable guide lines.

interface SnapGuideResult {
    dx: number;
    dy: number;
    xMatches: SnapMatch[];
    yMatches: SnapMatch[];
    guides: DiagramLineGuide[];
    options?: SnapOptions;
}

Hierarchy

SnapDeltaResult
- SnapGuideResult

Index

Properties

dx dy xMatches yMatches guides options?

Properties

dx

dx: number

Chosen X-axis snap delta.

dy

dy: number

Chosen Y-axis snap delta.

xMatches

xMatches: SnapMatch[]

Ordered list of all X-axis matches.

yMatches

yMatches: SnapMatch[]

Ordered list of all Y-axis matches.

guides

guides: DiagramLineGuide[]

Guides that can be rendered for visual feedback.

`Optional`options

options?: SnapOptions

Options used to compute this result.