Paikallisen tallennustilan ohjelmointirajapinta

Paikallisen tallennustilan ohjelmointirajapinnan avulla voit tallentaa tietoja selaimen paikalliseen tallennustilaan. Jotta voit käyttää paikallisen tallennustilan ohjelmointirajapintaa, asiakkaan paikallisen tallennustilan järjestelmänvalvojan valitsin on otettava käyttöön.

Paikallinen tallennustila on eristetty, jotta jokaisella visualisointityypillä on omat erilliset tallennustilakäyttöosuuden.

Muistiinpano

On kehittäjän vastuulla varmistaa, että tallennetut tiedot ovat kuluttajan organisaation käytäntöjen mukaisia, ja kertoa käyttäjille, mitä tietoja tallennetaan, jos tietojen arkaluontoisuus sitä edellyttää. Mukautettujen visualisointien kehittäjien tulee erityisesti salata tiedot, jos liiketoimintatavoitteet tai -skenaariot sitä odottavat.

Paikallisen tallennustilan käyttäminen

Versio 1

Tämä paikallisen tallennustilan ohjelmointirajapinnan versio on ajoitettu poistettavaksi käytöstä. Emme hyväksy enää pyyntöjä. Käytä mahdollisuuksien mukaan versiota 2.

Seuraavassa esimerkissä laskuri kasvaa aina, kun päivitysmenetelmää kutsutaan. Laskurin arvo tallennetaan paikallisesti, ja sitä kutsutaan aina, kun visualisointi käynnistyy. Näin laskuri jatkaa laskemista siitä, mihin se jäi, sen sijaan, että aloittaisi alusta aina, kun visualisointi käynnistetään:

export class Visual implements IVisual {
        // ...
        private updateCountName: string = 'updateCount';
        private updateCount: number;
        private storage: ILocalVisualStorageService;
        // ...

        constructor(options: VisualConstructorOptions) {
            // ...
            this.storage = options.host.storageService;
            // ...

            this.storage.get(this.updateCountName).then(count =>
            {
                this.updateCount = +count;
            })
            .catch(() =>
            {
                this.updateCount = 0;
                this.storage.set(this.updateCountName, this.updateCount.toString());
            });
            // ...
        }

        public update(options: VisualUpdateOptions) {
            // ...
            this.updateCount++;
            this.storage.set(this.updateCountName, this.updateCount.toString());
            // ...
        }
}

Versio 2

Paikallisen tallennustavan menetelmät

Paikallisen tallennustilan ohjelmointirajapinnassa on neljä menetelmää:

• status:

  • Palauttaa paikallisen tallennustilan v2 -ohjelmointirajapinnan tilan.

    • PrivilegeStatus.DisabledByAdmin: vuokraajan järjestelmänvalvojan valitsin on poissa käytöstä
    • PrivilegeStatus.NotDeclared: visualisoinnilla ei ole määritystä paikalliselle tallennustilalle oikeudet-matriisissa
    • PrivilegeStatus.NotSupported: ohjelmointirajapintaa ei tueta (katso lisätietoja rajoituksista )
    • PrivilegeStatus.Allowed: ohjelmointirajapintaa tuetaan ja sallitaan

  Ennen kuin käytät noutamis-, asetus- tai poistomenetelmiä , on parasta käyttää tilamenetelmää ohjelmointirajapinnan tilan tarkistamiseen ja sen varmistamiseen, että visualisointi käyttäytyy odotetulla tavalla.

• hae:

  • Tämä menetelmä odottaa yhtä parametria:

    • key – avain, jonka arvon haluat saada.

  • Palauttaa lupauksen, joka ratkaisee arvon, jos avain on olemassa, ja hylkää muussa tapauksessa.

• set:

  • Tämä menetelmä odottaa kahta parametria:

    • key – avain, jonka haluat määrittää sen arvoksi
    • data – avaimen arvo

  • Palauttaa lupauksen, jonka tuloksena on rakenne StorageV2ResultInfo, tai joka hylkää virheen ilmenneen.

• poista:

  • Tämä menetelmä odottaa yhtä parametria:

    • key – sen parin avain, jonka haluat poistaa

Paikallisen tallennustilan ohjelmointirajapinnan käyttäminen

Jos haluat käyttää paikallisen tallennustilan ohjelmointirajapintaa, lisää esittely visualisoinnin ominaisuuksien käyttöoikeudet-matriisiin.

Seuraavassa esimerkissä näytetään, miten voit määrittää ja noutaa tietoja paikallisesta tallennustilasta paikallisen tallennustilan ohjelmointirajapinnan versiolla 2:

import IVisualLocalStorageV2Service = powerbi.extensibility.IVisualLocalStorageV2Service; 
import StorageV2ResultInfo = powerbi.extensibility.StorageV2ResultInfo; 
import PrivilegeStatus = powerbi.PrivilegeStatus; 
 
export class Visual implements IVisual { 
    // ... 
    private updateCountName: string = 'updateCount'; 
    private updateCount: number; 
    private storageV2Service: IVisualLocalStorageV2Service; 
 
    constructor(options: VisualConstructorOptions) { 
        this.storageV2Service = options.host.storageV2Service; 
        this.init(); 
    } 
 
    private async init() { 
        try { 
            let status: powerbi.PrivilegeStatus = await this.storageV2Service.status(); 
            if (status === PrivilegeStatus.DisabledByAdmin) { 
                //handle if the api blocked by admin 
            } else if (status === PrivilegeStatus.Allowed) { 
                this.updateCount = await this.storageV2Service.get(this.updateCountName); 
            } 
        } catch (error) { 
            //handle error 
        } 
    } 

    private async updateCount(count: number) { 
        try { 
            let status: PrivilegeStatus = await this.storageV2Service.status(); 
            if (status === PrivilegeStatus.Allowed) { 
                let resultInfo: StorageV2ResultInfo = this.storageV2Service.set(this.updateCountName, count); 
                if (resultInfo.success) { 
                    //updateCount was set. 
                } else { 
 
                } 
            } 
        } catch (error) { 
            // handle error 
        } 
    } 

    private async removeUpdateCount() { 
        let status: PrivilegeStatus = await this.storageV2Service.status(); 
        if (status === PrivilegeStatus.Allowed) { 
            this.storageV2Service.remove(this.updateCountName); 
        } 
    } 
} 

Huomioitavat asiat ja rajoitukset

Huomioitavat asiat ja rajoitukset, versio 1

• Paikallinen tallennusrajoitus on 1 mt GUID-tunnusta kohti.
• Tietoja voidaan jakaa visualisointien välillä vain samoilla GUID-tunnuksilla.
• Tietoja ei voi jakaa toisen Power BI Desktop -esiintymän kanssa.
• Paikallisen tallennustilan ohjelmointirajapinta ei ole oletusarvoisesti aktivoitu. Jos haluat aktivoida sen Power BI -visualisoinnille, lähetä pyyntö Power BI -visualisointien tukeen, pbicvsupport@microsoft.com.
• Paikallisen tallennustilan ohjelmointirajapinta ei tue await rakenteita. Vain then ja catch -menetelmät sallitaan.

Visualisoinnin on oltava käytettävissä AppSourcessa ja sertifioitava.

Huomioitavat asiat ja rajoitukset, versio 2

• Mukautettujen visualisointien paikallisen tallennustilan raja on 100 kt.
• Tietoja voidaan jakaa visualisointien välillä, joissa on sama GUID-tunnus, samassa ympäristössä ja vain samalle käyttäjälle.
• Ohjelmointirajapintaa tuetaan seuraavissa ympäristöissä:
  • Verkko
  • Työpöytä
  • SaaS Embed
  • Mobiili
  • Raporttipalvelin
• Paikallista tallennustilaa ei tueta, kun viet PDF-muotoon tai pptx-tiedostoon.
• -ohjelmointirajapintaa tuetaan vain, kun käyttäjä on kirjautunut sisään.
• Visualisoinnin tiedot tyhjennetään 29 päivää viimeisimmän muokkausajan jälkeen.
• Tämä ohjelmointirajapinta on privileged-ohjelmointirajapinta.
• Avaimella (parametrilla, joka määritetään, nouda, poistetaan) on seuraavat rajoitukset:
  • Pituuden on oltava alle 128 merkkiä
  • Merkkiä |ei voi sisältää
• Jos selain on itsenäisen esityksen tilassa, paikallisen tallennustilan käytettävyys saattaa vaihdella selainten ja itsenäisen kioskin omistajan asetusten mukaan.
• On monia syitä, miksi tätä ohjelmointirajapintaa ei ehkä tueta. Esimerkiksi ympäristöä ei välttämättä tueta tai selaimen paikallinen tallennus ei ole käytettävissä. Suosittelemme tarkistamaan ohjelmointirajapinnan tilan ennen joukko- /nouda/poista-menetelmien käyttämistä. Virheenkäsittely on tärkeää, koska vaikka ohjelmointirajapintaa tuetaan, se voi epäonnistua.

Liittyvä sisältö

• Power BI:n mukautetun visualisoinnin ohjelmointirajapinta