modifiers_Modification.Modification.md

@interactjs / modifiers/Modification / Modification

Class: Modification

modifiers/Modification.Modification

Table of contents

Properties

• edges
• endResult
• interaction
• result
• startDelta
• startEdges
• startOffset
• states

Methods

• applyToInteraction
• beforeEnd
• copyFrom
• destroy
• fillArg
• prepareStates
• restoreInteractionCoords
• setAll
• setAndApply
• shouldDo
• start
• startAll
• stop

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

Name	Type
arg	Object
arg.phase	keyof PhaseMap
arg.rect?	Rect

Returns

void

Defined in

modifiers/Modification.ts:151

---

beforeEnd

▸ beforeEnd(arg): false | void

Parameters

Name	Type
arg	Omit<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

Name	Type
other	Modification

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

Name	Type
arg	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

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

Name	Type
modifierList	Modifier<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

Name	Type
«destructured»	Object
› interaction	Interaction<keyof ActionMap>

Returns

void

Defined in

modifiers/Modification.ts:310

---

setAll

▸ setAll(arg): ModificationResult

Parameters

Name	Type
arg	MethodArg & 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

Name	Type
arg	Partial<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

Name	Type
options	any
preEnd?	boolean
phase?	string
requireEndOnly?	boolean

Returns

boolean

Defined in

modifiers/Modification.ts:334

---

start

▸ start(«destructured», pageCoords): ModificationResult

Parameters

Name	Type
«destructured»	Object
› phase	keyof PhaseMap
pageCoords	Point

Returns

ModificationResult

Defined in

modifiers/Modification.ts:49

---

startAll

▸ startAll(arg): void

Parameters

Name	Type
arg	MethodArg & 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

Name	Type
arg	Object
arg.interaction	Interaction<keyof ActionMap>

Returns

void

Defined in

modifiers/Modification.ts:262