import AbstractEvent from '@shopify/draggable/src/shared/AbstractEvent/AbstractEvent.js'

public class | source

AbstractEvent

All events fired by draggable inherit this class. You can call cancel() to cancel a specific event or you can check if an event has been canceled by calling canceled().

Static Member Summary

Static Public Members
public static abstract	cancelable: Boolean Event cancelable
public static abstract	type: String Event type

Constructor Summary

Public Constructor
public	constructor(data: object) AbstractEvent constructor.

Member Summary

Public Members
public	[canceled]: boolean
public get abstract	cancelable: Boolean: * Read-only cancelable
public	data: *
public get abstract	type: String: * Read-only type

Method Summary

Public Methods
public abstract	cancel() Cancels the event instance
public abstract	canceled(): Boolean Check if event has been canceled
public	clone(data: Object): AbstractEvent Returns new event instance with existing event data.

Static Public Members

public static abstract cancelable: Boolean source

Event cancelable

Properties:

Name	Type	Attribute	Description
cancelable	*

public static abstract type: String source

Event type

Properties:

Name	Type	Attribute	Description
type	*

Public Constructors

public constructor(data: object) source

AbstractEvent constructor.

Params:

Name	Type	Attribute	Description
data	object		Event data

Public Members

public [canceled]: boolean source

public get abstract cancelable: Boolean: * source

Read-only cancelable

Return:

Boolean

public data: * source

public get abstract type: String: * source

Read-only type

Return:

String

Public Methods

public abstract cancel() source

Cancels the event instance

public abstract canceled(): Boolean source

Check if event has been canceled

Return:

Boolean

public clone(data: Object): AbstractEvent source

Returns new event instance with existing event data. This method allows for overriding of event data.

Params:

Name	Type	Attribute	Description
data	Object

Return:

AbstractEvent