startCondition property

EnumValue get startCondition

Gets or sets the starting condition for this trigger.

AnimationTriggers can invoke an animation immediately, starting a new animation with each property of each GraphObject that has been modified, or they can (more efficiently) be bundled together into the default animation (AnimationManager#defaultAnimation) and begin only one animation, at the end of the next transaction.

It is useful for the startCondition to be AnimationTrigger.Immediate when changing GraphObject properties on GraphObject#mouseEnter or GraphObject#mouseLeave. It is useful for the startCondition to be AnimationTrigger.Bundled when changing several GraphObject properties together, such as when highlighting multiple parts, on selection changes, and during transactions, or when performance is a consideration.

These behaviors can be set with the values AnimationTrigger.Immediate and AnimationTrigger.Bundled, respectively. The default value, AnimationTrigger.Default, attempts to infer which is best: It will start immediately if there is no ongoing transaction or if Diagram#skipsUndoManager is true, and otherwise bundle them.

Implementation

_i3.EnumValue get startCondition => _i4.getProperty(
      this,
      'startCondition',
    );
set startCondition (EnumValue value)

Implementation

set startCondition(_i3.EnumValue value) {
  _i4.setProperty(
    this,
    'startCondition',
    value,
  );
}