The type of the produced UI commands
Allows the processing of errors during the execution of the binding. Errors reported here are errors thrown in arrow functions provided to the the different routines of the binder and errors triggered by the command. A binder can have several cummulative 'catch' routines.
The function to process the error caught by the binding during its execution
A clone of the current binder to chain the building configuration.
Configures a linter rule specifically for the binding.
A clone of the current binder to chain the building configuration.
Specifies whether the command must be executed on each evolution of the interaction (if 'when' predicate is ok).
A clone of the current binder to chain the building configuration.
Defines actions to perform when a binding ends. A binder can have several cummulative 'end' routines.
The command to execute on each binding end.
A clone of the current builder to chain the building configuration.
Specifies the initialisation of the command when the interaction starts. Each time the interaction starts, an instance of the command is created and configured by the given callback. A binder can have several cummulative 'first' routines.
The callback method that initialises the command. This callback takes as arguments the command to configure.
A clone of the current binder to chain the building configuration.
Specifies the logging level to use. A binder can have several cummulative 'log' routines, eg: log(LogLevel.INTERACTION).log(LogLevel.COMMAND)
Rest ...level: readonly LogLevel[]The logging level to use.
A clone of the current binder to chain the building configuration.
Specifies the name of the Interacto binding. This name will be used in the logging system. It should be unique, but no mechanism will check that.
The name of the binding
A clone of the current binder to chain the building configuration.
Specifies the widgets on which the binding will operate. When a widget is added to this list, this widget is binded to this binding. When widget is removed from this list, this widget is unbinded from this binding.
A clone of the current binder to chain the building configuration.
Specifies the node the binding will observe its children. The binding observes its children list, so that additions and removals from it are managed by the binding.
The binding will observe the children of this node.
A clone of the current binder to chain the building configuration.
The default behavior associated to the event will be ignored.
A clone of the current binder to chain the building configuration.
If called, all the events the interaction will process will be consumed and not propagated to next listeners.
A clone of the current binder to chain the building configuration.
Permits to update the command on each interaction update. A binder can have several cummulative 'then' routines. This routine is called only if 'when' returns true (ie only if the condition for producing the command is respected). See 'ifCannotExecute' for a 'then' when this condition is not respected.
The callback method that updates the command. This callback takes as arguments the command to update.
A clone of the current binder to chain the building configuration.
Backpressure operation. Instead of emitting all the events, successive events of the same type are factorized modulo a timeout. The timeout is used to send at max one event of the same type in a given duration (the timeout). For example with three mouse moves and a time out of 10ms. The first move is received and processed. The timer starts. A second mouse moves is received at T+5ms. It is for the moment not processed. A third mouse move is received at T+8ms. The second move is finally ignored and this third one not processed yet. At T+10s the third event is finally processed. Based on our own experiments, the given timeout value should be greater than 10ms to throttle some UI events.
The timeout used by the throttle operation. In ms.
A clone of the current binder to chain the building configuration.
Specifies the conditions to fulfill to initialise, update, or execute the command while the interaction is running. A binder can have several cummulative 'when' routines.
The predicate that checks whether the command can be initialised, updated, or executed.
Optional mode: WhenTypeThe execution mode of the 'when' predicate. If not defined, the non-strict mode will be used.
A clone of the current binder to chain the building configuration.
Generated using TypeDoc
The binder API that already knows the type of UI command the bindings will produce. Routines related to interactions that can be updated are provided ('then').