Class Navigation

    • The Navigation object controls card navigation and can be used to manage a stack of cards.

    • Key methods include popCard() , popToNamedCard() , popToRoot() for removing cards, pushCard() for adding cards, and updateCard() for replacing the current card.

    • Most navigation methods return the Navigation object itself, allowing for method chaining.

    • The printJson() method is available for debugging purposes, providing the JSON representation of the object.
    Navigation

    A helper object that controls card navigation. See the card navigation guide for more details.

    Methods

    Method Return type Brief description
    pop Card()
    		Navigation Pops a card from the navigation stack.
    pop To Named Card(cardName)
    		Navigation Pops to the specified card by its card name.
    pop To Root()
    		Navigation Pops the card stack to the root card.
    print Json()
    		String Prints the JSON representation of this object.
    push Card(card)
    		Navigation Pushes the given card onto the stack.
    update Card(card)
    		Navigation Does an in-place replacement of the current card.

    Detailed documentation

    pop Card()

    Pops a card from the navigation stack. Can be chained with other card navigation actions.

    Return

    Navigation — This object, for chaining.

    pop To Named Card(cardName)

    Pops to the specified card by its card name. Can be chained with other card navigation actions.

    Parameters

    Name Type Description
    card Name
    		String The name of the card to navigate to.

    Return

    Navigation — This object, for chaining.

    pop To Root()

    Pops the card stack to the root card. Can be chained with other card navigation actions.

    Return

    Navigation — This object, for chaining.

    print Json()

    Prints the JSON representation of this object. This is for debugging only.

    Return

    String

    push Card(card)

    Pushes the given card onto the stack. Can be chained with other card navigation actions.

    Parameters

    Name Type Description
    card
    		Card A card to add to the stack.

    Return

    Navigation — This object, for chaining.

    update Card(card)

    Does an in-place replacement of the current card. Can be chained with other card navigation actions.

    Parameters

    Name Type Description
    card
    		Card A card to replace the current card with.

    Return

    Navigation — This object, for chaining.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: