leader-line-types.d.ts

//modified from https://github.com/hungtcs/leader-line-types/blob/master/types/index.d.ts
export type Element = HTMLElement | SVGElement;
export type PlugType = 'disc' | 'square' | 'arrow1' | 'arrow2' | 'arrow3' | 'hand' | 'crosshair' | 'behind';
export type PathType = 'straight' | 'arc' | 'fluid' | 'magnet' | 'grid';
export type SocketType = 'top' | 'right' | 'bottom' | 'left' | 'auto';
export type ShowEffectName = 'none' | 'fade' | 'draw';
export type AreaAnchorShape = 'rect' | 'circle' | 'polygon';

export interface LabelFontOptions {
    fontFamily?: any;
    fontStyle?: any;
    fontVariant?: any;
    fontWeight?: any;
    fontStretch?: any;
    fontSize?: any;
    fontSizeAdjust?: any;
    kerning?: any;
    letterSpacing?: any;
    wordSpacing?: any;
    textDecoration?: any;
}

export interface Options {
    end?: Element | AnchorAttachment;
    start?: Element | AnchorAttachment;

    size?: number;
    color?: string;
    path?: PathType;
    startSocket?: SocketType;
    endSocket?: SocketType;
    startSocketGravity?: number | string | Array<string | number>;
    endSocketGravity?: number | string | Array<string | number>;

    startPlug?: PlugType;
    endPlug?: PlugType;
    startPlugColor?: string;
    endPlugColor?: string;

    startPlugSize?: number;
    endPlugSize?: number;
    outline?: boolean;
    outlineColor?: string;
    outlineSize?: number;

    startPlugOutline?: boolean;
    endPlugOutline?: boolean;

    startPlugOutlineColor?: string;
    endPlugOutlineColor?: string;

    startPlugOutlineSize?: number;
    endPlugOutlineSize?: number;

    startLabel?: string | LabelAttachment;
    middleLabel?: string | LabelAttachment;
    endLabel?: string | LabelAttachment;

    dash?: boolean | DashOptions;
    gradient?: boolean | GradientOptions;
    dropShadow?: boolean | DropShadowOptions;

    show?: boolean;
    hide?: boolean;
}

export interface DashOptions {
    len?: number | string;
    gap?: number | string;

    animation?: boolean | AnimationOptions;
}

export interface GradientOptions {
    startColor?: string;
    endColor?: string;
}

export interface DropShadowOptions {
    dx?: number;
    dy?: number;
    blur?: number;
    color?: string;
    opacity?: number;
}

export interface AnimationOptions {
    timing?: 'ease' | 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | Array<number>;
    duration?: number;
}

export interface PointAnchorOptions {
    x?: string | number;
    y?: string | number;
    element?: Element;
}

export interface AreaAnchorOptions {
    x?: number | string;
    y?: number | string;
    shape?: AreaAnchorShape;
    width?: number | string;
    radius?: number;
    height?: number | string;
    element?: Element;
    points?: Array<[number|string, number|string]>;
    color?: string;
    fillColor?: string;
    size?: number;
    dash?: boolean | DashOptions;
}

export interface MouseHoverAnchorOptions {
    element?: Element;
    showEffectName?: ShowEffectName,
    animOptions?: AnimationOptions,
    style?: { [key: string]: any };
    hoverStyle?: { [key: string]: any };
    onSwitch?: (event: MouseEvent) => any;
}

export interface CaptionLabelOptions extends LabelFontOptions {
    text?: string;
    offset?: Array<number>;
    lineOffset?: number;
    color?: string;
    outlineColor?: string;
}

export interface PathLabelOptions extends LabelFontOptions {
    text?: string;
    lineOffset?: number;
    color?: string;
    outlineColor?: string;
}

export class LabelAttachment { }

export class AnchorAttachment { }



export class LeaderLine {
end: Element | AnchorAttachment;
start: Element | AnchorAttachment;
size: number;
color: string;
startSocketGravity: string;
endSocketGravity: string;
startPlugColor: string;
endPlugColor: string;
startPlugSize: number;
endPlugSize: number;
outline: boolean;
outlineColor: string;
outlineSize: number;
startPlugOutline: boolean;
endPlugOutline: boolean
startPlugOutlineColor: string;
endPlugOutlineColor: string;
startPlugOutlineSize: number;
endPlugOutlineSize: number;
path: PathType;
startSocket: SocketType;
endSocket: SocketType;
startPlug: PlugType;
endPlug: PlugType;
dash: boolean | DashOptions;
gradient: boolean | GradientOptions;
dropShadow: boolean;
startLabel: string | LabelAttachment;
endLabel: string | LabelAttachment;
middleLabel: string | LabelAttachment;

constructor(options: Options);
constructor(start: Element | AnchorAttachment, end: Element | AnchorAttachment, options?: Options);

static pointAnchor(options: PointAnchorOptions): AnchorAttachment;
static pointAnchor(element: Element, options?: PointAnchorOptions): AnchorAttachment;

static areaAnchor(options: AreaAnchorOptions): AnchorAttachment;
static areaAnchor(element: Element, options?: AreaAnchorOptions): AnchorAttachment;
static areaAnchor(element: Element, shape?: AreaAnchorShape, options?: AreaAnchorOptions): AnchorAttachment;

static mouseHoverAnchor(options: MouseHoverAnchorOptions): AnchorAttachment;
static mouseHoverAnchor(element: Element, showEffectName?: ShowEffectName, options?: MouseHoverAnchorOptions): AnchorAttachment;

static captionLabel(options: any): LabelAttachment;
static captionLabel(text?: string, options?: any): LabelAttachment;

static pathLabel(options: PathLabelOptions): LabelAttachment;
static pathLabel(text: string, options?: PathLabelOptions): LabelAttachment;

hide(showEffectName?: ShowEffectName, animOptions?: AnimationOptions): void;
show(showEffectName?: ShowEffectName, animOptions?: AnimationOptions): void;
remove(): void;
position(): void;
setOptions(options: Options): void;

}