Shell.UI.Pivots.js

Artikel
08/24/2015

Gäller för: Windows Azure Pack

Innehåller metoder för att hantera pivotlänkar på en tilläggssida.

Pivoter är länkarna under huvudrubriken på en tilläggssida som används för att navigera till undersidor.

Widgets

Inga.

Uppräkningar

Inga.

Typer

Shell.UI.Pivot(id, displayName, template, activated, image, visible, navFilter)

Namn	Typ	Beskrivning
id	Objekt	Pivotidentifieraren
displayName	Sträng	Visningsnamnet för Pivot.
mall	Objekt	Pivotmallen.
aktiverad	Funktion	Funktionen För pivotaktiverat återanrop.
image	Objekt	Pivotbilden.
Synliga	Boolesk	Pivotsynlighet.
navFilter	Objekt	Pivotnavigeringsfiltret.

Shell.UI.PivotImageDescriptor(url, urlHover, altText)

Namn	Typ	Beskrivning
url	Sträng	URL till bilden.
urlHover	Sträng	URL till hovringsbilden.
altText	Sträng	Alternativ text för bilden.

Egenskaper

Namn	Typ	Beskrivning
Shell.UI.Pivot.displayName	Sträng	Visningsnamnet för Pivot.
Shell.UI.Pivot.id	Objekt	Pivotidentifieraren.
Shell.UI.Pivot.image	Objekt	Pivotbilden.
Shell.UI.Pivot.navFilter	Objekt	Pivotnavigeringsfiltret.
Shell.UI.Pivot.template	Objekt	Pivotmallen.
Shell.UI.Pivot.visible	Boolesk	Pivotsynlighet. sant om pivoten visas, annars falskt.
Shell.UI.PivotImageDescriptor.altText	Sträng	Den alternativa texten för pivotbilden.
Shell.UI.PivotImageDescriptor.url	Sträng	URL:en för pivotbilden.
Shell.UI.PivotImageDescriptor.urlHover	Sträng	Url:en för pivotbilden för hovringsbilden.

Metoder

Name	Beskrivning	Returer	Parametrar
Shell.UI.Pivots.add	Lägger till listan över pivoter i den angivna listan med pivoter.	Ingenting	extensionId (Sträng): ID:t för tillägget som pivoterna läggs till för. pivot (matris): De pivoter som ska läggas till. Kan också ta ett enda Shell.UI.Pivot också.
Shell.UI.Pivots.clear	Tar bort alla pivoter för det aktiva tillägget.	Ingenting	extensionId: Tillägget som pivoten tillhör.
Shell.UI.Pivots.getPivotContentArea	Hämtar pivotinnehållsområdet.	Objekt	Inga.
Shell.UI.PivotImageDescriptor.getQuickStartIcon	Hämtar snabbstartsikonen för bildbeskrivningen. Returnerar ett PivotImageDescriptor-objekt som innehåller bildens URL, hovringsbilds-URL och alternativ text.	Objekt	Ingen
Shell.UI.Pivots.insert	Infogar en pivot vid den angivna positionen.	Ingenting	extensionId (Sträng): ID:t för tillägget som pivoterna läggs till för. pivot (Shell.UI.Pivot): De pivoter som ska infogas. position (Tal): Positionen som pivoten ska infogas på.
Shell.UI.Pivots.registerExtension	Registrerar tillägget.	Ingenting	Tillägg: Tillägget som ska registreras. initializeCallback: Återanropsfunktionen för initiering.
Shell.UI.Pivots.remove	Tar bort den angivna pivoten från listan över pivoter.	Ingenting	pivot (Shell.UI.Pivot): Pivoten som ska tas bort.
Shell.UI.Pivots.set	Anger pivoter.	Ingenting	extensionId (Sträng): ID:t för tillägget som pivoterna läggs till för. pivot (matris): De pivoter som ska anges. Kan också ta en enda Shell.UI.Pivot också.
Shell.UI.Pivots.update	Uppdateringar pivoteringslistan	Ingenting	extensionID: Pivot-tilläggsidentifieraren.

Exempel

Det första steget är att skapa tab-objektet.

tabs: [
    {
        id: "timeZoneList",
        displayName: "Time Zones",
        template: "tzsTimeZoneList",
        activated: tzs_opened
    },
    {
        id: "secondTab",
        displayName: "Another Tab",
        template: "tzsSecondTab"
    }
]

Eftersom sidväxling är vanligt i användargränssnittet är det en bra idé att skapa en återanvändbar funktion som initierar pivoterna igen varje gång sidan navigeras till.

initializePivots: function() {
    Shell.UI.Pivots.clear(this.name);
    Shell.UI.Pivots.add(this.name, this.tabs);

    // Another way to add is to add the tabs individually
    // Shell.UI.Pivots.add(new Shell.UI.Pivot("timeZoneList", "Time Zones", "tzsTimeZoneList", tzs_opened));
    // Shell.UI.Pivots.add(new Shell.UI.Pivot("secondTab", "Another Tab", "tzsSecondTab"));
    Shell.UI.Pivots.update(this.name);
}

Se även

Windows biblioteksreferens för Azure Pack Extension Shell

Dela via