,, , ,, , , , image/svg+xml , image/svg+xml , interact.js , image/svg+xml , ,, , ,

@interactjs

@interactjs

Table of contents

Modules

Support Ukraine 🇺🇦 Help Provide Humanitarian Aid to Ukraine.

@interactjs / modifiers/Modification / Modification

Class: Modification

modifiers/Modification.Modification

Table of contents

Properties

Methods

Properties

edges

• edges: EdgeOptions

Defined in

modifiers/Modification.ts:35

endResult

• endResult: Point

Defined in

modifiers/Modification.ts:33

interaction

• Readonly interaction: Readonly<Interaction<keyof ActionMap>>

Defined in

modifiers/Modification.ts:36

result

• result: ModificationResult

Defined in

modifiers/Modification.ts:32

startDelta

• startDelta: Point

Defined in

modifiers/Modification.ts:31

startEdges

• startEdges: EdgeOptions

Defined in

modifiers/Modification.ts:34

startOffset

• startOffset: Rect

Defined in

modifiers/Modification.ts:30

states

• states: { index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }[] = []

Defined in

modifiers/Modification.ts:29

Methods

applyToInteraction

â–¸ applyToInteraction(arg): void

Parameters

NameType
argObject
arg.phasekeyof PhaseMap
arg.rect?Rect

Returns

void

Defined in

modifiers/Modification.ts:151

beforeEnd

â–¸ beforeEnd(arg): false | void

Parameters

NameType
argOmit<DoAnyPhaseArg, "iEvent"> & { state?: { index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown } }

Returns

false | void

Defined in

modifiers/Modification.ts:232

copyFrom

â–¸ copyFrom(other): void

Parameters

NameType
otherModification

Returns

void

Defined in

modifiers/Modification.ts:352

destroy

â–¸ destroy(): void

Returns

void

Defined in

modifiers/Modification.ts:361

fillArg

â–¸ fillArg(arg): ModifierArg<{ index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }>

Parameters

NameType
argPartial<ModifierArg<{ index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }>>

Returns

ModifierArg<{ index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }>

Defined in

modifiers/Modification.ts:73

prepareStates

â–¸ prepareStates(modifierList): { index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }[]

Parameters

NameType
modifierListModifier<any, any, any, any>[]

Returns

{ index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }[]

Defined in

modifiers/Modification.ts:293

restoreInteractionCoords

▸ restoreInteractionCoords(«destructured»): void

Parameters

NameType
«destructured»Object
› interactionInteraction<keyof ActionMap>

Returns

void

Defined in

modifiers/Modification.ts:310

setAll

â–¸ setAll(arg): ModificationResult

Parameters

NameType
argMethodArg & Partial<ModifierArg<{ index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }>>

Returns

ModificationResult

Defined in

modifiers/Modification.ts:95

setAndApply

â–¸ setAndApply(arg): false | void

Parameters

NameType
argPartial<DoAnyPhaseArg> & { modifiedCoords?: Point ; phase: keyof PhaseMap ; preEnd?: boolean ; skipModifiers?: number }

Returns

false | void

Defined in

modifiers/Modification.ts:185

shouldDo

â–¸ shouldDo(options, preEnd?, phase?, requireEndOnly?): boolean

Parameters

NameType
optionsany
preEnd?boolean
phase?string
requireEndOnly?boolean

Returns

boolean

Defined in

modifiers/Modification.ts:334

start

▸ start(«destructured», pageCoords): ModificationResult

Parameters

NameType
«destructured»Object
› phasekeyof PhaseMap
pageCoordsPoint

Returns

ModificationResult

Defined in

modifiers/Modification.ts:49

startAll

â–¸ startAll(arg): void

Parameters

NameType
argMethodArg & Partial<ModifierArg<{ index?: number ; methods?: { beforeEnd?: (arg: ModifierArg<any>) => void | Point ; set?: (arg: ModifierArg<any>) => any ; start?: (arg: ModifierArg<any>) => void ; stop?: (arg: ModifierArg<any>) => void } ; name?: any ; options: unknown }>>

Returns

void

Defined in

modifiers/Modification.ts:86

stop

â–¸ stop(arg): void

Parameters

NameType
argObject
arg.interactionInteraction<keyof ActionMap>

Returns

void

Defined in

modifiers/Modification.ts:262