Shell.UI.Navigation.js

 

Gäller för: Windows Azure Pack

Tillhandahåller navigeringsfunktioner.

Widgets

Inga.

Uppräkningar

Inga.

Egenskaper

Namn	Typ	Beskrivning
Shell.UI.Navigation.WellKnownPropertyNames.alwaysVisibile	Boolesk	Avgör synlighet.
Shell.UI.Navigation.WellKnownPropertyNames.count	Objekt	Antalet.
Shell.UI.Navigation.WellKnownPropertyNames.displayError	Sträng	Visningsfelet.
Shell.UI.Navigation.WellKnownPropertyNames.displayName	Sträng	Visningsnamnet.
Shell.UI.Navigation.WellKnownPropertyNames.displayWarning	Sträng	Visningsvarningen.
Shell.UI.Navigation.WellKnownPropertyNames.icon	Objekt	Ikonens URI.
Shell.UI.Navigation.WellKnownPropertyNames.collection	Objekt	Navigeringsobjekten.
Shell.UI.Navigation.WellKnownPropertyNames.name	Sträng	Namnet.
Shell.UI.Navigation.WellKnownPropertyNames.showSpinner	Objekt	Showspinnern.
Shell.UI.Navigation.WellKnownPropertyNames.tooltip	Objekt	Verktygstipset

Metoder

Name	Beskrivning	Returer	Parametrar
Shell.UI.Navigation.calculateNavigationPath	Beräknar navigeringssökvägen. Returvärde är den beräknade navigeringssökvägen.	Sträng	Alternativ: navigeringssökvägen som ska beräknas. Alternativ är ett objekt med följande egenskaper Tillägg: Tillägget. Typ: Typ. Namn: Namnet. Vy: Vyn dataContext: Datakontexten. expandPath: Sant för att expandera sökvägen, annars Falskt.
Shell.UI.Navigation.cdmNavigateTo	Navigera programmatiskt till ett nytt område i programmet	Ingenting	hashPath (Sträng): Område att navigera till.
Shell.UI.Navigation.crackNavigationPath	Hämtar den spruckna navigeringssökvägen som är ett objekt med följande värden. Hash: Hash-värdet. Tillägg: Tillägget. Vy: Vyn. viewName: vynamnet. item: Objektet. itemName: objektnamnet. itemType: Objekttypen.	Objekt	Hash: Hashen som används för att knäcka navigeringsvägen.
Shell.UI.Navigation.currentLocation	Hämtar den aktuella platsen	Objekt Objektet representerar den aktuella platsen och har följande egenskaper: extension: Tilläggets namn. view: Vyn. viewName: Vynamnet. item: Objektet. itemName: Objektets namn. itemType: Objekttypen.	Ingen
Shell.UI.Navigation.expandDefaultHashPath	Expanderar standardsökvägen för hash för ett tillägg. Returnerar den expanderade hash-sökvägen.	Sträng	Tillägg: tillägget hashPath: Hash-sökvägen.
Shell.UI.Navigation.getBasePath	Hämtar bassökvägen.	Sträng	Ingen
Shell.UI.Navigation.getHashPathType	Tar en hashpath (t.ex. från location.hash) och returnerar komponenten "typ" för som har om den finns.	Sträng	hashPath (Sträng): En hashpath från en URL som är i navigeringsformat.
Shell.UI.Navigation.getObservableExtensionBadge	Returnerar tilläggets navigeringsmärke.	Sträng	Tillägg: Tilläggsnamnet.
Shell.UI.Navigation.initializeNav	Initierar navigering.	Ingenting	Ingen
Shell.UI.Navigation.isNavigatedTo	Returnerar sant om filnamnstillägget, vyn, objektet och objekttypen navigeras.	Boolesk	extensionName: Tilläggsnamnet. viewName: vynamnet. itemName: Objektnamnet. itemType: Objekttypen.
Shell.UI.Navigation.navigate	Navigerar till det angivna målet.	Ingenting	Mål: Målet att navigera till.
Shell.UI.Navigation.removeConfirmNavigateAway	Tar bort meddelandet bekräfta navigera bort.	Ingenting	Inga.
Shell.UI.Navigation.selectExtension	Väljer ett tillägg.	Ingenting	Tillägg: Det tillägg som ska väljas.
Shell.UI.Navigation.setConfirmNavigateAway	Anger meddelandet bekräfta navigera bort.	Ingenting	Meddelande: Bekräfta navigeringsmeddelandet.

Exempel

Hur gör jag för att ange den plats där bakåtknappen pekar på?

Från datafunktionen returnerar du ett objekt som har en backNavigationProperty. Den här egenskapen anger vart bakåtknappen ska ta dig. Den här egenskapen använder Shell.UI.Navigation.calculateNavigationPath() för den här egenskapen för att fastställa hashen.

function dataFunction(...) {
// Code to acquire the data used to populate he list of the second level of navigation
// ...
    return {
        data: [...], //
        label: "label of the back button",
            backNavigation: {
                type: "the type id you want the back button to point to",
                view: "the view id you want the back button to point to",
                name: "the id of the item you want to point to"
            }
    };
}

Hur gör jag för att definiera flera "nivåer" av navigering?

Föreställ dig följande scenario. Du vill skapa ett tillägg som visar ett rutnät med objekt av typen "A" (kanske en SQL Server). Om du klickar på någon av dessa visas en lista med objekt av typen "B" i den instansen av A (kanske SQL databaser). I sin tur bör cliquing på en instans av "B" i rutnätet ta dig till ett rutnät med objekt av typen "C" (kanske tabeller i databasen). Detta görs via navigationDependencies.

_types = [
    {
        name: "A",
        displayName: "A - SQL Server",
        dataFunction: function() {}, // data function here
        tabs: [{
            id: "AllAs",
            displayName: "SQL servers",
            template: "a template name",
            activated: function() {}, // tab activated function here
        }]
    },
    {
        name: "B",
        displayName: "B - SQL Database",
        navigationDependencies: {
            A: "AId"
        },
        dataFunction: function() {}, // data function here
        tabs: [{
            id: "AllBs",
            displayName: "SQL Databases",
            template: "a template name",
            activated: function() {}, // tab activated function here
        }]
    },
    {
        name: "C",
        displayName: "B - SQL Table",
        navigationDependencies: {
            B: "BId"
        },
        dataFunction: function() {}, // data function here
        tabs: [{
            id: "AllCs",
            displayName: "SQL Tables",
            template: "a template name",
            activated: function() {}, // tab activated function here
        }]
    }
];

Se även

biblioteksreferens för Windows Azure Pack-tilläggsgränssnitt