v7.3.0

DragBase
Abstract

Base class for EventDrag (Scheduler) and TaskDrag (Gantt) features. Contains shared code for drag-and-drop operations on events including tooltip display, snapping, and constraint handling. Not to be used directly.

See also

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class
  • constrainDragToTimeline : Booleantrue

    Set to false to allow dragging tasks outside the client Scheduler. Useful when you want to drag tasks between multiple Scheduler instances

  • dragHelperConfig : DragHelperConfig

    An object used to configure the internal DragHelper class

  • showExactDropPosition : Booleanfalse

    When enabled, the event being dragged always "snaps" to the exact start date that it will have after drop.

  • showTooltip : Booleantrue

    Specifies whether to show tooltip while dragging event

    Has a corresponding runtime showTooltip property.

  • throttleDragEvent : Boolean

    The eventDragand taskDrag events are normally only triggered when the drag operation will lead to a change in date or assignment. By setting this config to false, that logic is bypassed to trigger events for each native mouse move event.

    Has a corresponding runtime throttleDragEvent property.

  • tip : TooltipConfig

    A config object to allow customization of the Tooltip which tracks the event during a drag operation.

    Has a corresponding runtime tip property.

Properties

Properties are getters/setters or publicly accessible variables on this class
  • isDragBase : Booleantrue
    READONLY
    static
    ADVANCED
    Identifies an object as an instance of DragBase class, or subclass thereof.
  • isDragging : Boolean
    READONLY

    Returns true if a drag operation is active

  • showTooltip : Booleantrue

    Specifies whether to show tooltip while dragging event

    Has a corresponding showTooltip config.

  • throttleDragEvent : Boolean

    The eventDragand taskDrag events are normally only triggered when the drag operation will lead to a change in date or assignment. By setting this config to false, that logic is bypassed to trigger events for each native mouse move event.

    Has a corresponding throttleDragEvent config.

  • tip : Tooltip

    Yields the Tooltip which tracks the event during a drag operation.

    Has a corresponding tip config.

  • isDragBase : Booleantrue
    READONLY
    ADVANCED
    Identifies an object as an instance of DragBase class, or subclass thereof.

Functions

Functions are methods available for calling on the class
    • getTipHtml( )

      Gets html to display in tooltip while dragging event. Uses clockTemplate to display start & end dates.

    • onDrag( )
      private

      Triggered while dragging an event. Updates drag data, validation etc.

    • onDragStart( )
      private

      Triggered when dragging of an event starts. Initializes drag data associated with the event being dragged.

    • onDrop( )
      private

      Triggered when dropping an event. Finalizes the operation.

    • onInternalInvalidDrop( )
      private

      Triggered internally on invalid drop.

    • onInternalPaint( )
      private

      Called when scheduler is rendered. Sets up drag and drop and hover tooltip.

    • updateDragContext( )
      private

      Updates drag data's dates and validity (calls #validatorFn if specified)

    Source path

    Scheduler/feature/base/DragBase.js

    Contents