bpmn-js/lib/features/modeling/behavior/util/LineAttachmentUtil.d.ts

A bpmn 2.0 toolkit and web modeler

/**
 * Return the attachment of the given point on the specified line.
 *
 * The attachment is either a bendpoint (attached to the given point)
 * or segment (attached to a location on a line segment) attachment:
 *
 * ```javascript
 * var pointAttachment = {
 *   type: 'bendpoint',
 *   bendpointIndex: 3,
 *   position: { x: 10, y: 10 } // the attach point on the line
 * };
 *
 * var segmentAttachment = {
 *   type: 'segment',
 *   segmentIndex: 2,
 *   relativeLocation: 0.31, // attach point location between 0 (at start) and 1 (at end)
 *   position: { x: 10, y: 10 } // the attach point on the line
 * };
 * ```
 *
 * @param point
 * @param line
 *
 * @return
 */
export function getAttachment(point: Point, line: Point[]): Attachment;

type Point = import('diagram-js/lib/util/Types').Point;

export type Attachment = {
    type: 'bendpoint' | 'segment';
    position: Point;
    segmentIndex: number;
    bendpointIndex?: number;
    relativeLocation?: number;
};