Interface SortableEvent

interface SortableEvent {
    AT_TARGET: number;
    BUBBLING_PHASE: number;
    CAPTURING_PHASE: number;
    NONE: number;
    bubbles: boolean;
    cancelBubble: boolean;
    cancelable: boolean;
    clone: HTMLElement;
    composed: boolean;
    currentTarget: null | EventTarget;
    defaultPrevented: boolean;
    eventPhase: number;
    from: HTMLElement;
    isTrusted: boolean;
    item: HTMLElement;
    newDraggableIndex: undefined | number;
    newIndex: undefined | number;
    newIndicies: {
        index: number;
        multiDragElement: HTMLElement;
    }[];
    oldDraggableIndex: undefined | number;
    oldIndex: undefined | number;
    oldIndicies: {
        index: number;
        multiDragElement: HTMLElement;
    }[];
    pullMode: undefined | boolean | "clone";
    returnValue: boolean;
    srcElement: null | EventTarget;
    swapItem: null | HTMLElement;
    target: HTMLElement;
    timeStamp: number;
    to: HTMLElement;
    type: string;
    composedPath(): EventTarget[];
    initEvent(type, bubbles?, cancelable?): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy

  • Event
    • SortableEvent

Properties

AT_TARGET BUBBLING_PHASE CAPTURING_PHASE NONE bubbles cancelBubble cancelable clone composed currentTarget defaultPrevented eventPhase from isTrusted item newDraggableIndex newIndex newIndicies oldDraggableIndex oldIndex oldIndicies pullMode returnValue srcElement swapItem target timeStamp to type

Methods

composedPath initEvent preventDefault stopImmediatePropagation stopPropagation

Properties

Readonly AT_TARGET

AT_TARGET: number

Readonly BUBBLING_PHASE

BUBBLING_PHASE: number

Readonly CAPTURING_PHASE

CAPTURING_PHASE: number

Readonly NONE

NONE: number

Readonly bubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

cancelBubble

cancelBubble: boolean

Deprecated

Readonly cancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

clone

clone: HTMLElement

Readonly composed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

Readonly currentTarget

currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

Readonly defaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

Readonly eventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

from

from: HTMLElement

previous list

Readonly isTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

item

item: HTMLElement

dragged element

newDraggableIndex

newDraggableIndex: undefined | number

New index within parent, only counting draggable elements

newIndex

newIndex: undefined | number

new index within parent

newIndicies

newIndicies: {
    index: number;
    multiDragElement: HTMLElement;
}[]

When MultiDrag is used to sort, this holds a HTMLElement and newIndex for each item.

oldIndicies[number] is directly related to newIndicies[number]

If MultiDrag is not used to sort, this array will be empty.

Type declaration

  • index: number
  • multiDragElement: HTMLElement

oldDraggableIndex

oldDraggableIndex: undefined | number

Old index within parent, only counting draggable elements

oldIndex

oldIndex: undefined | number

old index within parent

oldIndicies

oldIndicies: {
    index: number;
    multiDragElement: HTMLElement;
}[]

When MultiDrag is used to sort, this holds a HTMLElement and oldIndex for each item selected.

oldIndicies[number] is directly related to newIndicies[number]

If MultiDrag is not used to sort, this array will be empty.

Type declaration

  • index: number
  • multiDragElement: HTMLElement

pullMode

pullMode: undefined | boolean | "clone"

Pull mode if dragging into another sortable

returnValue

returnValue: boolean

Deprecated

Readonly srcElement

srcElement: null | EventTarget

Deprecated

swapItem

swapItem: null | HTMLElement

When Swap is used to sort, this will contain the dragging item that was dropped on.

target

target: HTMLElement

Readonly timeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

to

to: HTMLElement

list, in which moved element.

Readonly type

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

Methods

composedPath

  • composedPath(): EventTarget[]

  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    Returns EventTarget[]

initEvent

  • initEvent(type, bubbles?, cancelable?): void

  • Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

    Deprecated

preventDefault

  • preventDefault(): void

  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    Returns void

stopPropagation

  • stopPropagation(): void

  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc