AI-generated Key Takeaways
-
The
Navigationobject 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, andupdateCard()for replacing the current card. -
Most navigation methods return the
Navigationobject itself, allowing for method chaining. -
The
printJson()method is available for debugging purposes, providing the JSON representation of the object.
A helper object that controls card navigation. See the card navigation guide for more details.
Methods
| Method | Return type | Brief description |
|---|---|---|
pop | Navigation | Pops a card from the navigation stack. |
pop | Navigation | Pops to the specified card by its card name. |
pop | Navigation | Pops the card stack to the root card. |
print | String | Prints the JSON representation of this object. |
push | Navigation | Pushes the given card onto the stack. |
update | Navigation | Does an in-place replacement of the current card. |
Detailed documentation
popCard()
Pops a card from the navigation stack. Can be chained with other card navigation actions.
Return
Navigation — This object, for chaining.
popToNamedCard(cardName)
Pops to the specified card by its card name. Can be chained with other card navigation actions.
Parameters
| Name | Type | Description |
|---|---|---|
card | String | The name of the card to navigate to. |
Return
Navigation — This object, for chaining.
popToRoot()
Pops the card stack to the root card. Can be chained with other card navigation actions.
Return
Navigation — This object, for chaining.
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
pushCard(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.
updateCard(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.