AngularTS
    Preparing search index...

    Class Transition

    Represents a transition between two states.

    When navigating to a state, we are transitioning from the current state to the new state.

    This object contains all contextual information about the to/from states, parameters, resolves. It has information about all states being entered and exited as a result of the transition.

    Index

    Properties

    $id: number
    promise: Promise<StateDeclaration>
    success: boolean | undefined

    Methods

    • Returns StateObject

      the internal from [State] object

    • Returns StateObject

      the internal to [State] object

    • Aborts this transition

      Imperative API to abort a Transition. This only applies to Transitions that are not yet complete.

      Returns void

    • Returns void

    • Returns true if the transition is dynamic.

      A transition is dynamic if no states are entered nor exited, but at least one dynamic parameter has changed.

      Returns boolean

      true if the Transition is dynamic

    • The Transition error reason.

      If the transition is invalid (and could not be run), returns the reason the transition is invalid. If the transition was valid and ran, but was not successful, returns the reason the transition failed.

      Returns Rejection | undefined

      a transition rejection explaining why the transition is invalid, or the reason the transition failed.

    • Returns the "from state"

      Returns the state that the transition is coming from.

      Returns StateDeclaration

      The state declaration object for the Transition's ("from state").

    • Checks if this transition is currently active/running.

      Returns boolean

    • Creates a new transition that is a redirection of the current one.

      This transition can be returned from a [[TransitionService]] hook to redirect a transition to a new state and/or set of parameters.

      Parameters

      • targetState: TargetState

        the new target state for the redirected transition

      Returns Transition

      Returns a new [[Transition]] instance.

    • Returns the "to state"

      Returns the state that the transition is going to.

      Returns StateDeclaration

      The state declaration object for the Transition's target state ("to state").

    • A string representation of the Transition

      Returns string

      A string representation of the Transition

    • Checks if the Transition is valid

      Returns boolean

      true if the Transition is valid