Class Bindings<H>`Abstract`

A contextual object for creating binders and thus bindings. allows the observation of the created bindings. Provides an undo/redo history. Why a pure abstract class and not an interface? Because interfaces are not retained at runtime in TS and we want DI (that thus cannot inject interface types).

Type Parameters

H extends UndoHistoryBase
The undo history algorithm

Hierarchy

Bindings
- BindingsImpl

Index

Constructors

constructor

new Bindings<H>(): Bindings<H>
Type Parameters
- H extends UndoHistoryBase
Returns Bindings<H>

Properties

`Readonly` `Abstract` logger

logger: Logger

`Readonly` `Abstract` undoHistory

undoHistory: H

The undo/redo history of the current binding context

Methods

`Abstract` acceptVisitor

acceptVisitor(visitor): void
Visiting the binding.
Parameters
- visitor: VisitorBinding
  The visitor.
Returns void
- Defined in api/binding/Bindings.ts:594

`Abstract` buttonBinder

buttonBinder<A>(accInit?): PartialButtonTypedBinder<A>
Creates binding builder to build a binding between a button interaction and the given command type. Do not forget to call bind() at the end of the build to execute the builder.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialButtonTypedBinder<A>
The binding builder.
- Defined in api/binding/Bindings.ts:215

`Abstract` checkboxBinder

checkboxBinder<A>(accInit?): PartialInputTypedBinder<A>
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialInputTypedBinder<A>
- Defined in api/binding/Bindings.ts:217

`Abstract` clear

clear(): void
Clears all the data of this binding context: the possible current BindingsObserver object; the undo/redo history.

Returns void
- Defined in api/binding/Bindings.ts:582

`Abstract` clickBinder

clickBinder<A>(accInit?): PartialPointTypedBinder<A>
Creates a binding that uses the click interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialPointTypedBinder<A>
- Defined in api/binding/Bindings.ts:433

`Abstract` clicksBinder

clicksBinder<A>(nbClicks, accInit?): PartialPointsTypedBinder<A>
Creates a binding for clicking n times.
Type Parameters
- A
Parameters
- nbClicks: number
  The number of clicks to do. If this number is not reached, the interaction is cancelled after a timeout of 1s.
- Optional accInit: A
Returns PartialPointsTypedBinder<A>
- Defined in api/binding/Bindings.ts:468

`Abstract` colorPickerBinder

colorPickerBinder<A>(accInit?): PartialInputTypedBinder<A>
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialInputTypedBinder<A>
- Defined in api/binding/Bindings.ts:219

`Abstract` combine

combine<XS, A>(interactions, accInit?): PartialThenBinder<XS, A>
Create a binding that uses an ordered sequence of user interactions
Type Parameters
- XS extends Interaction<InteractionData>[]
- A
Parameters
- interactions: XS
  The sequence of user interaction
- Optional accInit: A
Returns PartialThenBinder<XS, A>
- Defined in api/binding/Bindings.ts:574

`Abstract` comboBoxBinder

comboBoxBinder<A>(accInit?): PartialSelectTypedBinder<A>
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialSelectTypedBinder<A>
- Defined in api/binding/Bindings.ts:221

`Abstract` dateBinder

dateBinder<A>(accInit?): PartialInputTypedBinder<A>
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialInputTypedBinder<A>
- Defined in api/binding/Bindings.ts:225

`Abstract` dbleClickBinder

dbleClickBinder<A>(accInit?): PartialUpdatePointTypedBinder<A>
Creates a binding that uses the double click interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialUpdatePointTypedBinder<A>
- Defined in api/binding/Bindings.ts:443

`Abstract` dndBinder

dndBinder<A>(cancellable, accInit?): PartialPointSrcTgtTypedBinder<A>
Creates a binding that uses the DnD interaction.
Type Parameters
- A
Parameters
- cancellable: boolean
  True: the escape key will cancels the DnD.
- Optional accInit: A
Returns PartialPointSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:496

`Abstract` dragLockBinder

dragLockBinder<A>(accInit?): PartialPointSrcTgtTypedBinder<A>
Creates a binding that uses the drag lock interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialPointSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:510

`Abstract` fourTouchBinder

fourTouchBinder<A>(accInit?): PartialFourTouchTypedBinder<A>
Creates a binding that uses four (DnD) touches.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialFourTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:274

`Abstract` hyperlinkBinder

hyperlinkBinder<A>(accInit?): PartialAnchorTypedBinder<A>
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialAnchorTypedBinder<A>
- Defined in api/binding/Bindings.ts:227

`Abstract` keyDownBinder

keyDownBinder<A>(modifierAccepted, accInit?): PartialKeyTypedBinder<A>
Creates a binding that uses the KeyDown (key pressed) interaction.
Type Parameters
- A
Parameters
- modifierAccepted: boolean
  True: the interaction will consider key modifiers.
- Optional accInit: A
Returns PartialKeyTypedBinder<A>
- Defined in api/binding/Bindings.ts:516

`Abstract` keyTypeBinder

keyTypeBinder<A>(accInit?): PartialKeyTypedBinder<A>
Creates a binding that uses the KeyTyped (key pressed then released) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialKeyTypedBinder<A>
- Defined in api/binding/Bindings.ts:537

`Abstract` keyUpBinder

keyUpBinder<A>(modifierAccepted, accInit?): PartialKeyTypedBinder<A>
Creates a binding that uses the KeyUp (key released) interaction.
Type Parameters
- A
Parameters
- modifierAccepted: boolean
  True: the interaction will consider key modifiers.
- Optional accInit: A
Returns PartialKeyTypedBinder<A>
- Defined in api/binding/Bindings.ts:527

`Abstract` keysDownBinder

keysDownBinder<A>(accInit?): PartialKeysTypedBinder<A>
Creates a binding that uses the KeysDown (multiple keys pressed) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialKeysTypedBinder<A>
- Defined in api/binding/Bindings.ts:521

`Abstract` keysTypeBinder

keysTypeBinder<A>(accInit?): PartialKeysTypedBinder<A>
Creates a binding that uses the KeysType (multiple keys pressed then released) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialKeysTypedBinder<A>
- Defined in api/binding/Bindings.ts:532

`Abstract` longMouseDownBinder

longMouseDownBinder<A>(duration, accInit?): PartialUpdatePointTypedBinder<A>
Creates a binding that uses the LongMouseDown (mouse button pressed for a certain amount of time) interaction.
Type Parameters
- A
Parameters
- duration: number
  The duration of the pressure to end the user interaction. If this duration is not reached, the interaction is cancelled.
- Optional accInit: A
Returns PartialUpdatePointTypedBinder<A>
- Defined in api/binding/Bindings.ts:461

`Abstract` longTouchBinder

longTouchBinder<A>(duration, accInit?): PartialTouchTypedBinder<A>
Creates a binding that uses the long touch interaction.
Type Parameters
- A
Parameters
- duration: number
  The duration of the touch to end the user interaction. If this duration is not reached, the interaction is cancelled.
- Optional accInit: A
Returns PartialTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:293

`Abstract` longpressOrTouchBinder

longpressOrTouchBinder<A>(duration, accInit?): PartialPointOrTouchTypedBinder<A>
Creates a binding that uses either a longpress or a longtouch interaction.
Type Parameters
- A
Parameters
- duration: number
- Optional accInit: A
Returns PartialPointOrTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:552

`Abstract` mouseDownBinder

mouseDownBinder<A>(accInit?): PartialPointTypedBinder<A>
Creates a binding that uses the MouseDown (mouse button pressed) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialPointTypedBinder<A>
- Defined in api/binding/Bindings.ts:448

`Abstract` mouseDownOrTouchStartBinder

mouseDownOrTouchStartBinder<A>(accInit?): PartialPointOrTouchTypedBinder<A>
Creates a binding that uses either a mouse down or a touch start interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialPointOrTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:542

`Abstract` mouseEnterBinder

mouseEnterBinder<A>(withBubbling, accInit?): PartialPointTypedBinder<A>
Creates a binding that uses the MouseEnter (mouse cursor enters the element) interaction.
Type Parameters
- A
Parameters
- withBubbling: boolean
  True: event bubbling is enabled and events on child elements will be registered
- Optional accInit: A
Returns PartialPointTypedBinder<A>
- Defined in api/binding/Bindings.ts:474

`Abstract` mouseLeaveBinder

mouseLeaveBinder<A>(withBubbling, accInit?): PartialPointTypedBinder<A>
Creates a binding that uses the MouseLeave (mouse cursor leaves the element) interaction.
Type Parameters
- A
Parameters
- withBubbling: boolean
  True: event bubbling is enabled and events on child elements will be registered
- Optional accInit: A
Returns PartialPointTypedBinder<A>
- Defined in api/binding/Bindings.ts:480

`Abstract` mouseMoveBinder

mouseMoveBinder<A>(accInit?): PartialPointTypedBinder<A>
Creates a binding that uses the MouseMove (mouse cursor moves) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialPointTypedBinder<A>
- Defined in api/binding/Bindings.ts:485

`Abstract` mouseUpBinder

mouseUpBinder<A>(accInit?): PartialPointTypedBinder<A>
Creates a binding that uses the MouseUp (mouse button released) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialPointTypedBinder<A>
- Defined in api/binding/Bindings.ts:453

`Abstract` multiTouchBinder

multiTouchBinder<A>(nbTouches, accInit?): PartialMultiTouchTypedBinder<A>
Creates a binding that uses the multi-touch user interaction.
Type Parameters
- A
Parameters
- nbTouches: number
  The number of required touches. A multi-touch starts when all its touches have started. A multi-touch ends when the number of required touches is greater than the number of touches.
- Optional accInit: A
Returns PartialMultiTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:259

`Abstract` nodeBinder

nodeBinder<A>(accInit?): BaseUpdateBinder
Type Parameters
- A
Parameters
- Optional accInit: A
Returns BaseUpdateBinder
- Defined in api/binding/Bindings.ts:208

`Abstract` panBinder

panBinder<A>(cancellable, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses the pan interaction (in all direction, one touch). The involved user interaction is TouchDnD.
Type Parameters
- A
Parameters
- cancellable: boolean
  Whether the DnD can be cancelled by interacting with a dwell-and-spring element.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:300

`Abstract` panBottomBinder

panBottomBinder<A>(pxTolerance, cancellable, minLength?, minVelocity?, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses a bottom pan interaction (or swipe if minVelocity is used) interaction (one-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- cancellable: boolean
  Whether the DnD can be cancelled by interacting with a dwell-and-spring element.
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:359

`Abstract` panHorizontalBinder

panHorizontalBinder<A>(pxTolerance, cancellable, minLength?, minVelocity?, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses a vertical pan interaction (or swipe if minVelocity is used) interaction (one-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- cancellable: boolean
  Whether the DnD can be cancelled by interacting with a dwell-and-spring element.
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:319

`Abstract` panLeftBinder

panLeftBinder<A>(pxTolerance, cancellable, minLength?, minVelocity?, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses a left pan interaction (or swipe if minVelocity is used) interaction (one-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- cancellable: boolean
  Whether the DnD can be cancelled by interacting with a dwell-and-spring element.
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:329

`Abstract` panRightBinder

panRightBinder<A>(pxTolerance, cancellable, minLength?, minVelocity?, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses a right pan interaction (or swipe if minVelocity is used) interaction (one-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- cancellable: boolean
  Whether the DnD can be cancelled by interacting with a dwell-and-spring element.
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:339

`Abstract` panTopBinder

panTopBinder<A>(pxTolerance, cancellable, minLength?, minVelocity?, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses a top pan interaction (or swipe if minVelocity is used) interaction (one-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- cancellable: boolean
  Whether the DnD can be cancelled by interacting with a dwell-and-spring element.
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:349

`Abstract` panVerticalBinder

panVerticalBinder<A>(pxTolerance, cancellable, minLength?, minVelocity?, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses a vertical pan (or swipe if minVelocity is used) interaction (one-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- cancellable: boolean
  Whether the DnD can be cancelled by interacting with a dwell-and-spring element.
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:309

`Abstract` reciprocalDndBinder

reciprocalDndBinder<A>(handle, spring, accInit?): PartialPointSrcTgtTypedBinder<A>
Creates a binding that uses the Reciprocal DnD interaction. A spring handle can be pressed on a long click to return the element back to its previous position.
Type Parameters
- A
Parameters
- handle: EltRef<SVGCircleElement>
  The selectable part of the spring widget.
- spring: EltRef<SVGLineElement>
  The line between the handle and the previous position of the element.
- Optional accInit: A
Returns PartialPointSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:504

`Abstract` reciprocalMouseOrTouchDnD

reciprocalMouseOrTouchDnD<A>(handle, spring, accInit?): PartialTouchMouseDnDTypedBinder<A>
Creates a binding that uses either a longpress or a longtouch interaction.
Type Parameters
- A
Parameters
- handle: EltRef<SVGCircleElement>
- spring: EltRef<SVGLineElement>
- Optional accInit: A
Returns PartialTouchMouseDnDTypedBinder<A>
- Defined in api/binding/Bindings.ts:557

`Abstract` reciprocalTouchDnDBinder

reciprocalTouchDnDBinder<A>(handle, spring, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses the Reciprocal DnD interaction with a touch. A spring handle can be pressed on a long click to return the element back to its previous position.
Type Parameters
- A
Parameters
- handle: EltRef<SVGCircleElement>
  The selectable part of the spring widget.
- spring: EltRef<SVGLineElement>
  The line between the handle and the previous position of the element.
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:250

`Abstract` rotateBinder

rotateBinder<A>(pxTolerance, accInit?): PartialRotateTypedBinder<A>
Creates a binding that uses the rotate interaction (two-touch interaction, with the first point that must remain static).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the rotation (i.e. the acceptance rate when moving the fixation/first point).
- Optional accInit: A
Returns PartialRotateTypedBinder<A>
- Defined in api/binding/Bindings.ts:422

`Abstract` scaleBinder

scaleBinder<A>(pxTolerance, accInit?): PartialScaleTypedBinder<A>
Creates a binding that uses the scale/pinch touch interaction.
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the scale/pinch gesture
- Optional accInit: A
Returns PartialScaleTypedBinder<A>
- Defined in api/binding/Bindings.ts:428

`Abstract` scrollBinder

scrollBinder<A>(accInit?): PartialScrollTypedBinder<A>
Creates a binding that uses the mouse scroll interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialScrollTypedBinder<A>
- Defined in api/binding/Bindings.ts:490

`Abstract` setBindingObserver

setBindingObserver(obs?): void
Sets the current BindingsObserver object. Cleans the potential former global BindingsObserver object.
Parameters
- Optional obs: BindingsObserver
  The new BindingsObserver object to consider. Can be undefined.
Returns void
- Defined in api/binding/Bindings.ts:588

`Abstract` spinnerBinder

spinnerBinder<A>(accInit?): PartialSpinnerTypedBinder<A>
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialSpinnerTypedBinder<A>
- Defined in api/binding/Bindings.ts:223

`Abstract` tapBinder

tapBinder<A>(nbTap, accInit?): PartialTapsTypedBinder<A>
Creates a binding that uses the tap user interaction.
Type Parameters
- A
Parameters
- nbTap: number
  The number of required taps. If this number is not reached after a timeout, the interaction is cancelled.
- Optional accInit: A
Returns PartialTapsTypedBinder<A>
- Defined in api/binding/Bindings.ts:281

`Abstract` tapsOrClicksBinder

tapsOrClicksBinder<A>(nbTap, accInit?): PartialPointsOrTapsTypedBinder<A>
Creates a binding that uses either a tap or a clicks interaction.
Type Parameters
- A
Parameters
- nbTap: number
- Optional accInit: A
Returns PartialPointsOrTapsTypedBinder<A>
- Defined in api/binding/Bindings.ts:547

`Abstract` textInputBinder

textInputBinder<A>(timeout?, accInit?): PartialTextInputTypedBinder<A>
Creates a binding that uses a text interaction. This binder takes as argument a timeout value: using this text writing interaction, a user can write a sequence of letters and then stops for more than x milliseconds (x is the value of timeout). After this delay the binding executes the command. This is a mainstream optimisation that many text processing tools implement to limit the number of editing actions.
Type Parameters
- A
Parameters
- Optional timeout: number
  The timeout in milliseconds after which the interaction stops and the command produced.
- Optional accInit: A
Returns PartialTextInputTypedBinder<A>
- Defined in api/binding/Bindings.ts:236

`Abstract` threeTouchBinder

threeTouchBinder<A>(accInit?): PartialThreeTouchTypedBinder<A>
Creates a binding that uses three (DnD) touches.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialThreeTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:269

`Abstract` touchDnDBinder

touchDnDBinder<A>(cancellable, accInit?): PartialTouchSrcTgtTypedBinder<A>
Creates a binding that uses the touch DnD interaction (a DnD interaction that uses one touch). This interaction works as a Drag-and-Drop interaction.
Type Parameters
- A
Parameters
- cancellable: boolean
- Optional accInit: A
Returns PartialTouchSrcTgtTypedBinder<A>
- Defined in api/binding/Bindings.ts:242

`Abstract` touchStartBinder

touchStartBinder<A>(accInit?): PartialTouchTypedBinder<A>
Creates a binding that uses the MouseDown (mouse button pressed) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:286

`Abstract` twoPanBottomBinder

twoPanBottomBinder<A>(pxTolerance, minLength?, minVelocity?, accInit?): PartialTwoPanTypedBinder<A>
Creates a binding that uses a bottom pan interaction (two-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTwoPanTypedBinder<A>
- Defined in api/binding/Bindings.ts:413

`Abstract` twoPanHorizontalBinder

twoPanHorizontalBinder<A>(pxTolerance, minLength?, minVelocity?, accInit?): PartialTwoPanTypedBinder<A>
Creates a binding that uses a vertical pan interaction (two-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTwoPanTypedBinder<A>
- Defined in api/binding/Bindings.ts:377

`Abstract` twoPanLeftBinder

twoPanLeftBinder<A>(pxTolerance, minLength?, minVelocity?, accInit?): PartialTwoPanTypedBinder<A>
Creates a binding that uses a left pan interaction (two-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTwoPanTypedBinder<A>
- Defined in api/binding/Bindings.ts:386

`Abstract` twoPanRightBinder

twoPanRightBinder<A>(pxTolerance, minLength?, minVelocity?, accInit?): PartialTwoPanTypedBinder<A>
Creates a binding that uses a right pan interaction (two-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTwoPanTypedBinder<A>
- Defined in api/binding/Bindings.ts:395

`Abstract` twoPanTopBinder

twoPanTopBinder<A>(pxTolerance, minLength?, minVelocity?, accInit?): PartialTwoPanTypedBinder<A>
Creates a binding that uses a top pan interaction (two-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTwoPanTypedBinder<A>
- Defined in api/binding/Bindings.ts:404

`Abstract` twoPanVerticalBinder

twoPanVerticalBinder<A>(pxTolerance, minLength?, minVelocity?, accInit?): PartialTwoPanTypedBinder<A>
Creates a binding that uses a vertical pan interaction (two-touch).
Type Parameters
- A
Parameters
- pxTolerance: number
  The tolerance rate in pixels accepted while executing the pan
- Optional minLength: number
  The minimal distance from the starting point to the release point for validating the pan
- Optional minVelocity: number
  The pan while be a swipe: the minimal minVelocity to reach for validating the swipe. In pixels per second.
- Optional accInit: A
Returns PartialTwoPanTypedBinder<A>
- Defined in api/binding/Bindings.ts:368

`Abstract` twoTouchBinder

twoTouchBinder<A>(accInit?): PartialTwoTouchTypedBinder<A>
Creates a binding that uses two (DnD) touches.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialTwoTouchTypedBinder<A>
- Defined in api/binding/Bindings.ts:264

`Abstract` undoRedoBinder

undoRedoBinder(undo, redo, catchFn?): [Binding<Command, Interaction<WidgetData<HTMLButtonElement>>, unknown, WidgetData<HTMLButtonElement>>, Binding<Command, Interaction<WidgetData<HTMLButtonElement>>, unknown, WidgetData<HTMLButtonElement>>]
Creates two bindings for undo and redo operations with buttons.
Parameters
- undo: Widget<HTMLButtonElement>
  The undo button
- redo: Widget<HTMLButtonElement>
  The redo button
- Optional catchFn: ((err) => void)
  The function that will treat the errors for both undo and redo bindings
  - - (err): void
    - Parameters
      err: unknown
      Returns void
Returns [Binding<Command, Interaction<WidgetData<HTMLButtonElement>>, unknown, WidgetData<HTMLButtonElement>>, Binding<Command, Interaction<WidgetData<HTMLButtonElement>>, unknown, WidgetData<HTMLButtonElement>>]
- Defined in api/binding/Bindings.ts:566

`Abstract` wheelBinder

wheelBinder<A>(accInit?): PartialWheelTypedBinder<A>
Creates a binding that uses the Wheel (user uses a mouse scrolling wheel) interaction.
Type Parameters
- A
Parameters
- Optional accInit: A
Returns PartialWheelTypedBinder<A>
- Defined in api/binding/Bindings.ts:438

Class Bindings<H>Abstract

Type Parameters

H extends UndoHistoryBase

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

H extends UndoHistoryBase

Returns Bindings<H>

Properties

Readonly Abstract logger

Readonly Abstract undoHistory

Methods

Abstract acceptVisitor

Parameters

visitor: VisitorBinding

Returns void

Abstract buttonBinder

Type Parameters

A

Parameters

Optional accInit: A

Returns PartialButtonTypedBinder<A>

Abstract checkboxBinder

Type Parameters

A

Parameters

Optional accInit: A

Returns PartialInputTypedBinder<A>

Abstract clear

Returns void

Abstract clickBinder

Type Parameters

A

Parameters

Optional accInit: A

Returns PartialPointTypedBinder<A>

Abstract clicksBinder

Type Parameters

A

Parameters

nbClicks: number

Optional accInit: A

Returns PartialPointsTypedBinder<A>

Abstract colorPickerBinder

Type Parameters

A

Parameters

Optional accInit: A

Returns PartialInputTypedBinder<A>

Abstract combine

Type Parameters

XS extends Interaction<InteractionData>[]

A

Parameters

interactions: XS

Optional accInit: A

Returns PartialThenBinder<XS, A>

Abstract comboBoxBinder

Type Parameters

A

Parameters

Optional accInit: A

Returns PartialSelectTypedBinder<A>

Abstract dateBinder

Type Parameters

A

Parameters

Optional accInit: A

Returns PartialInputTypedBinder<A>

Abstract dbleClickBinder

Type Parameters

A

Parameters

Optional accInit: A

Returns PartialUpdatePointTypedBinder<A>

Class Bindings<H>`Abstract`

`Readonly` `Abstract` logger

`Readonly` `Abstract` undoHistory

`Abstract` acceptVisitor

`Abstract` buttonBinder

`Optional` accInit: A

`Abstract` checkboxBinder

`Optional` accInit: A

`Abstract` clear

`Abstract` clickBinder

`Optional` accInit: A

`Abstract` clicksBinder

`Optional` accInit: A

`Abstract` colorPickerBinder

`Optional` accInit: A

`Abstract` combine

`Optional` accInit: A

`Abstract` comboBoxBinder

`Optional` accInit: A

`Abstract` dateBinder

`Optional` accInit: A

`Abstract` dbleClickBinder

`Optional` accInit: A

`Abstract` dndBinder

`Optional` accInit: A

`Abstract` dragLockBinder

`Optional` accInit: A

`Abstract` fourTouchBinder

`Optional` accInit: A

`Abstract` hyperlinkBinder

`Optional` accInit: A

`Abstract` keyDownBinder

`Optional` accInit: A

`Abstract` keyTypeBinder

`Optional` accInit: A

`Abstract` keyUpBinder

`Optional` accInit: A

`Abstract` keysDownBinder

`Optional` accInit: A

`Abstract` keysTypeBinder

`Optional` accInit: A

`Abstract` longMouseDownBinder

`Optional` accInit: A

`Abstract` longTouchBinder

`Optional` accInit: A