Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • jsPlumbInstance

Index

Constructors

Methods

  • Parameters

    Returns void

  • batch(fn: Function, doNotRepaintAfterwards?: boolean): void
  • Parameters

    • fn: Function
    • Optional doNotRepaintAfterwards: boolean

    Returns void

  • bind(event: "connection", callback: ((info: export=.ConnectionMadeEventInfo, originalEvent: Event) => void), insertAtStart?: boolean): void
  • bind(event: "click", callback: ((info: export=.Connection, originalEvent: Event) => void), insertAtStart?: boolean): void
  • bind(event: string, callback: ((info: export=.OnConnectionBindInfo, originalEvent: Event) => void), insertAtStart?: boolean): void
  • cleanupListeners(): void
  • Returns void

  • deleteEveryConnection(): void
  • Returns void

  • empty(el: string | Element): void
  • Parameters

    • el: string | Element

    Returns void

  • expandGroup(group: string | export=.Group, doNotFireEvent?: boolean): void
  • Parameters

    • group: string | export=.Group
    • Optional doNotFireEvent: boolean

    Returns void

  • fire(event: string, value: Object, originalEvent: Event): void
  • Parameters

    • event: string
    • value: Object
    • originalEvent: Event

    Returns void

  • getConnections(scope: string, options: Object, scope2?: string, source?: string, target?: string, flat?: boolean): any[] | Record<any, any>
  • Parameters

    • scope: string
    • options: Object
    • Optional scope2: string
    • Optional source: string
    • Optional target: string
    • Optional flat: boolean

    Returns any[] | Record<any, any>

  • getContainer(): Element
  • Returns Element

  • getDefaultScope(): string
  • Returns string

  • getHoverPaintStyle(params?: Object, scope?: string, source?: string | any[] | Element, target?: string | any[] | Element, element?: string | any[] | Element): Selection
  • Parameters

    • Optional params: Object
    • Optional scope: string
    • Optional source: string | any[] | Element
    • Optional target: string | any[] | Element
    • Optional element: string | any[] | Element

    Returns Selection

  • getRotation(elementId: string): number
  • Gets the current rotation, if any, for the element with the given id. If no specific rotation has been applied this method will return 0, never null or undefined.

    Parameters

    • elementId: string

      ID of the element to retrieve rotation for.

    Returns number

    The element's current rotation, 0 if no rotation applied.

  • getScope(Element: string | Element): string
  • Parameters

    • Element: string | Element

    Returns string

  • getSelector(context?: string | Element, spec?: string): void
  • Parameters

    • Optional context: string | Element
    • Optional spec: string

    Returns void

  • getSourceScope(element: string | Element): string
  • Parameters

    • element: string | Element

    Returns string

  • getTargetScope(element: string | Element): string
  • Parameters

    • element: string | Element

    Returns string

  • getType(id: string, typeDescriptor: string): Object
  • Parameters

    • id: string
    • typeDescriptor: string

    Returns Object

  • getZoom(): number
  • Returns number

  • Parameters

    • el: string | Element
    • Optional changeEndpoints: boolean

    Returns jsPlumbInstance

  • isHoverSuspended(): boolean
  • Returns boolean

  • isSource(el: string | Element): boolean
  • Parameters

    • el: string | Element

    Returns boolean

  • isSourceEnabled(el: string | Element, connectionType?: string): boolean
  • Parameters

    • el: string | Element
    • Optional connectionType: string

    Returns boolean

  • isSuspendDrawing(): boolean
  • Returns boolean

  • isSuspendEvents(): boolean
  • Returns boolean

  • isTarget(el: string | Element): boolean
  • Parameters

    • el: string | Element

    Returns boolean

  • isTargetEnabled(el: string | Element): boolean
  • Parameters

    • el: string | Element

    Returns boolean

  • makeSource(el: string | Element, params: Object, endpoint?: string | any[], parent?: string | Element, scope?: string, dragOptions?: Object, deleteEndpointsOnEmpty?: boolean, filter?: Function): void
  • Parameters

    • el: string | Element
    • params: Object
    • Optional endpoint: string | any[]
    • Optional parent: string | Element
    • Optional scope: string
    • Optional dragOptions: Object
    • Optional deleteEndpointsOnEmpty: boolean
    • Optional filter: Function

    Returns void

  • makeTarget(el: string | Element, params: Object, endpoint?: string | any[], scope?: string, dropOptions?: Object, deleteEndpointsOnEmpty?: boolean, maxConnections?: number, onMaxConnections?: Function): void
  • Parameters

    • el: string | Element
    • params: Object
    • Optional endpoint: string | any[]
    • Optional scope: string
    • Optional dropOptions: Object
    • Optional deleteEndpointsOnEmpty: boolean
    • Optional maxConnections: number
    • Optional onMaxConnections: Function

    Returns void

  • Parameters

    • el: string | Element
    • event: string
    • fn: Function

    Returns jsPlumbInstance

  • on(el: string | Element, children?: string, event?: string, fn?: Function): jsPlumbInstance
  • Parameters

    • el: string | Element
    • Optional children: string
    • Optional event: string
    • Optional fn: Function

    Returns jsPlumbInstance

  • ready(fn: Function): void
  • Parameters

    • fn: Function

    Returns void

  • recalculateOffsets(el: string | Element): void
  • Parameters

    • el: string | Element

    Returns void

  • refreshAllGroups(): void
  • Returns void

  • registerConnectionType(typeId: string, type: Object): void
  • Parameters

    • typeId: string
    • type: Object

    Returns void

  • registerConnectionTypes(types: Object): void
  • Parameters

    • types: Object

    Returns void

  • registerEndpointType(typeId: string, type: Object): void
  • Parameters

    • typeId: string
    • type: Object

    Returns void

  • registerEndpointTypes(types: Object): void
  • Parameters

    • types: Object

    Returns void

  • remove(el: string | Element): void
  • Parameters

    • el: string | Element

    Returns void

  • removeAllEndpoints(el: string | Element, recurse?: boolean): jsPlumbInstance
  • Parameters

    • el: string | Element
    • Optional recurse: boolean

    Returns jsPlumbInstance

  • removeAllGroups(deleteMembers: string, manipulateDOM?: boolean, doNotFireEvent?: boolean): void
  • Parameters

    • deleteMembers: string
    • Optional manipulateDOM: boolean
    • Optional doNotFireEvent: boolean

    Returns void

  • reset(doNotUnbindInstanceEventListeners?: boolean): void
  • Parameters

    • Optional doNotUnbindInstanceEventListeners: boolean

    Returns void

  • Rotates the element with the given id by the given amount in degrees. This method sets two properties on the element's style: transform:rotate(<amount>deg) and transform-origin:center center. Transform origins other than center center are not supported. To reset the rotation for some element, call rotate(elId, 0).

    Parameters

    • elId: string
    • amountInDegrees: number
    • Optional doNotRedraw: boolean

    Returns export=.RedrawResult

    a RedrawResult, which is empty if no redraw was requested (or an element with the given id is not being managed)

  • select(params?: Object, scope?: string, source?: string, target?: string, connections?: export=.Connection[]): { each: any }
  • setContainer(el: string | Element): void
  • Parameters

    • el: string | Element

    Returns void

  • setDraggable(el: string | Object | any[], draggable: boolean): void
  • Parameters

    • el: string | Object | any[]
    • draggable: boolean

    Returns void

  • setHover(container: string | Element): void
  • Parameters

    • container: string | Element

    Returns void

  • setHoverSuspended(hover: boolean): void
  • Parameters

    • hover: boolean

    Returns void

  • setIdChanged(oldId: string, newId: string): void
  • Parameters

    • oldId: string
    • newId: string

    Returns void

  • setParent(el: string | Element, newParent: string | Element): void
  • Parameters

    • el: string | Element
    • newParent: string | Element

    Returns void

  • setScope(el: string | Element, scope: string): void
  • Parameters

    • el: string | Element
    • scope: string

    Returns void

  • setSourceScope(el: string | Element, scope: string, connectionType?: string): void
  • Parameters

    • el: string | Element
    • scope: string
    • Optional connectionType: string

    Returns void

  • setSuspendDrawing(val: boolean, repaintAfterwards?: boolean): boolean
  • Parameters

    • val: boolean
    • Optional repaintAfterwards: boolean

    Returns boolean

  • setSuspendEvents(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

  • setTargetScope(el: string | Element, scope: string, connectionType?: string): void
  • Parameters

    • el: string | Element
    • scope: string
    • Optional connectionType: string

    Returns void

  • setZoom(val: number, repaintEverything?: boolean): boolean
  • Parameters

    • val: number
    • Optional repaintEverything: boolean

    Returns boolean

  • Parameters

    • el: string | Element
    • Optional changeEndpoints: boolean

    Returns jsPlumbInstance

  • toggleDraggable(el: string | Element): boolean
  • Parameters

    • el: string | Element

    Returns boolean

  • toggleSourceEnabled(el: string | Element): boolean
  • Parameters

    • el: string | Element

    Returns boolean

  • toggleTargetEnabled(el: string | Element): boolean
  • Parameters

    • el: string | Element

    Returns boolean

  • toggleVisible(el: string | Element, changeEndpoints?: boolean): void
  • Parameters

    • el: string | Element
    • Optional changeEndpoints: boolean

    Returns void

  • unbind(eventOrListener?: string | Function, listener?: Function): void
  • Parameters

    • Optional eventOrListener: string | Function
    • Optional listener: Function

    Returns void

Generated using TypeDoc