jslib-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

dragInteraction

  • dragInteraction(element: HTMLElement): object

  • Sets up the required events and listeners for a complete drag interaction.

    Parameters

    • element: HTMLElement

    Returns object

    Object containing the interaction data.

mouseAndTouch

  • mouseAndTouch(element: HTMLElement): object

  • Sets up mouse and touch event handlers for an element and provides methods for attaching callbacks.

    Parameters

    • element: HTMLElement

    Returns object

    A readonly object.

positionData

  • positionData(element: HTMLElement): object

  • Provides an object containing useful position data.

    Parameters

    • element: HTMLElement

    Returns object

    Object.

    • compoundX: number
    • compoundY: number
    • currentX: number
    • currentY: number
    • element: HTMLElement
    • endX: number
    • endY: number
    • previousCompoundX: number
    • previousCompoundY: number
    • previousX: number
    • previousY: number
    • relativeX: number
    • relativeY: number
    • startX: number
    • startY: number
    • transitionX: number
    • transitionY: number
    • velocityX: number
    • velocityY: number
    • setFinalPosition: function
      • setFinalPosition(x: number, y: number): void

      • Parameters

        • x: number
        • y: number

        Returns void

    • setInitialPosition: function
      • setInitialPosition(x: number, y: number): void

      • Parameters

        • x: number
        • y: number

        Returns void

    • setUpdatedPosition: function
      • setUpdatedPosition(x: number, y: number): void

      • Parameters

        • x: number
        • y: number

        Returns void

triggerCallback

  • triggerCallback<T>(callback: T, ...args: any[]): void

  • Type parameters

    • T

    Parameters

    • callback: T
    • Rest ...args: any[]

    Returns void

triggerCallbacks

  • triggerCallbacks<T, K>(callbacks: T[], ...args: any[]): void

  • Type parameters

    • T

    • K

    Parameters

    • callbacks: T[]
    • Rest ...args: any[]

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc