Type Parameters

  • T

Constructors

  • Creates a new DataviewDragManager instance which handles the events of dragging a dataview item. Provide the dataview control and optionally provide the class of the disabled dataview items.

    Provide a type to define how your "dragData" will look like. The drag data can be used to "transfer" data from an event to a another one. The object can be fully customized and defined by yourself.

    Type Parameters

    • T

    Parameters

    • dataview: Dataview
    • Optional disabledClass: string

      optional (default: 'cfgrctrl-disabled')

    Returns CbnDataviewDragManager<T>

Properties

_dataViewItemDisabledClass: string = 'cfgrctrl-disabled'
_dragData: undefined | T
_dragState: DragState
_targetDataview: undefined | Dataview
onDrag: ((manager, e) => void)

Type declaration

    • (manager, e): void
    • Parameters

      • manager: this
      • e: MouseEvent | TouchEvent

      Returns void

onDragEnd: ((manager, e) => void)

Type declaration

    • (manager, e): void
    • Parameters

      • manager: this
      • e: MouseEvent | TouchEvent

      Returns void

onDragStart: ((manager, e, item) => void)

Type declaration

    • (manager, e, item): void
    • Parameters

      • manager: this
      • e: MouseEvent | TouchEvent
      • item: HTMLElement

      Returns void

Methods

  • Initialize all the default drag events and call the custom overwrite methods.

    Returns void

  • Create the Drag Image with its correct dimensions also respecting the current viewers zoom value.

    Parameters

    • targetElement: Element

      The element where the dragged item should be droppable and added to.

    • viewerZoom: number

      The current zoom lvl of the viewer.

    • width: number

      The width of the image that should be created.

    • height: number

      The height of the image that should be created.

    • src: string

      The url/src of the image that should be created.

    Returns {
        dragImageContainer: HTMLDivElement;
        imageHeight: number;
        imageWidth: number;
    }

    • dragImageContainer: HTMLDivElement
    • imageHeight: number
    • imageWidth: number
  • Default DragStart.

    Parameters

    • e: MouseEvent | TouchEvent
    • item: HTMLElement

    Returns void

  • Triggers the update for the dataview drag listeners. Use this whenever the data entries of the dataview get updated to ensure every drag listener is correctly registered to handle the drag.

    Returns void

    void