ViewNavigator class

Paquet:

@microsoft/sp-adaptive-card-extension-base

Gère une pile de vues.

Remarques

Le haut de la pile représente la vue actuellement rendue.

Constructeurs

(constructor)(handleStackChangedCallback, handleInitializeCallback)

Construit une nouvelle instance de la ViewNavigator classe

Propriétés

currentId	Obtenir l’ID de l’affichage actuellement rendu en haut de la pile d’affichage
size	Taille actuelle de la pile d’affichage.

Méthodes

pop(skipUpdate)	S’il existe plusieurs affichages, affiche l’affichage supérieur à partir de la pile Affichage. BaseAdaptiveCardExtension.setState(), qui déclenche également un rendu.
push(id, skipUpdate)	Envoie (push) une nouvelle vue en haut de la pile d’affichage. BaseAdaptiveCardExtension.setState(), qui déclenche également un rendu.
register(id, initializer)	Inscrit une nouvelle vue.
replace(id, skipUpdate)	Remplace la vue supérieure par une nouvelle vue. BaseAdaptiveCardExtension.setState(), qui déclenche également un rendu.

Détails du constructeur

(constructor)(handleStackChangedCallback, handleInitializeCallback)

Construit une nouvelle instance de la ViewNavigator classe

constructor(handleStackChangedCallback: (skipUpdate: boolean) => void, handleInitializeCallback: (view: TView) => void);

Paramètres

handleStackChangedCallback

(skipUpdate: boolean) => void

handleInitializeCallback

(view: TView) => void

Détails de la propriété

currentId

Obtenir l’ID de l’affichage actuellement rendu en haut de la pile d’affichage

get currentId(): string | undefined;

Valeur de propriété

string | undefined

Remarques

Si la pile est vide, cela retourne undefined

size

Taille actuelle de la pile d’affichage.

get size(): number;

Valeur de propriété

number

Détails de la méthode

pop(skipUpdate)

S’il existe plusieurs affichages, affiche l’affichage supérieur à partir de la pile Affichage.

BaseAdaptiveCardExtension.setState(), qui déclenche également un rendu.

pop(skipUpdate?: boolean): void;

Paramètres

skipUpdate

boolean

Indique s’il faut ignorer la mise à jour (et effectuer un rendu) après l’affichage actuel.

Retours

void

push(id, skipUpdate)

Envoie (push) une nouvelle vue en haut de la pile d’affichage.

BaseAdaptiveCardExtension.setState(), qui déclenche également un rendu.

push(id: string, skipUpdate?: boolean): void;

Paramètres

id

string

Identificateur unique de la vue.

skipUpdate

boolean

Indique s’il faut ignorer la mise à jour (et le rendu) après avoir envoyé (push) la nouvelle vue.

Retours

void

register(id, initializer)

Inscrit une nouvelle vue.

register(id: string, initializer: () => TView | Promise<TView>): void;

Paramètres

id

string

Identificateur unique de la vue.

initializer

() => TView | Promise<TView>

Fonction qui retourne une nouvelle vue ( ou une promesse à une nouvelle vue ) qui est appelée uniquement si aucune vue avec le n’existe id déjà.

Retours

void

Remarques

Une vue avec un donné id n’est initialisée qu’une seule fois, et le instance est réutilisé s’il est envoyé (push) plusieurs fois

replace(id, skipUpdate)

Remplace la vue supérieure par une nouvelle vue.

BaseAdaptiveCardExtension.setState(), qui déclenche également un rendu.

replace(id: string, skipUpdate?: boolean): void;

Paramètres

id

string

Identificateur unique de la vue.

skipUpdate

boolean

Indique s’il faut ignorer la mise à jour (et effectuer un rendu) après le remplacement de l’affichage actuel.

Retours

void