Jaa

Visualisoinnin ohjelmointirajapinta

  • Artikkeli

Kaikki visualisoinnit alkavat luokalla, joka ottaa käyttöön -liittymän IVisual . Voit nimetä luokan miksi tahansa, kunhan olemassa on täsmälleen yksi luokka, joka ottaa käyttöön -liittymän IVisual .

Muistiinpano

Visualisoinnin luokan nimen on oltava sama kuin visualClassName -tiedostossa pbiviz.json .

Visualisointiluokan tulee toteuttaa seuraavat menetelmät seuraavassa mallissa esitetyllä tavalla:

  • constructor – vakiokonstruktori, joka alustaa visualisoinnin tilan
  • update – visualisoinnin tietojen päivittäminen
  • getFormattingModel, palauttaa muotoilumallin, joka täyttää ominaisuusruudun (muotoiluasetukset), jossa voit muokata ominaisuuksia tarpeen mukaan
  • destroy - vakiodestruktori puhdistusta varten
class MyVisual implements IVisual {
    
    constructor(options: VisualConstructorOptions) {
        //one time setup code goes here (called once)
    }
    
    public update(options: VisualUpdateOptions): void {
        //code to update your visual goes here (called on all view or data changes)
    }

    public getFormattingModel(): FormattingModel {
        // returns modern format pane formatting model that contain all format pane components and properties (called on opening format and analytics pane or on editing format properties)
    }
    
    public destroy(): void {
        //one time cleanup code goes here (called once)
    }
}

rakentaja

constructor Visualisointiluokkaa kutsutaan, kun visualisoinnin esiintymä luodaan. Sitä voidaan käyttää missä tahansa visualisoinnin tarvitsemisen toimintojen määrittämisessä.

constructor(options: VisualConstructorOptions)

VisualConstructorOptions

Nämä liittymät päivitetään jokaisen uuden ohjelmointirajapintaversion mukana. Saat päivitetyimmän liittymämuodon GitHub-säilöstä.

Seuraavassa luettelossa kuvataan joitain liittymän VisualConstructorOptions ominaisuuksia:

  • element: HTMLElement – viittaus DOM-elementtiin, joka sisältää visualisoinnin

  • host: IVisualHost – kokoelma ominaisuuksia ja palveluja, joita voidaan käyttää vuorovaikutuksessa visualisoinnin isännän (Power BI) kanssa

    IVisualHost sisältää seuraavat palvelut:

    • createSelectionIdBuilder – luo ja tallentaa metatietoja visualisoinnin valittavissa olevia kohteita varten
    • createSelectionManager - luo viestintäsillan, jonka avulla visualisoinnin isännälle ilmoitetaan valintatilan muutoksista; katso Valinnan ohjelmointirajapinta.
    • hostCapabilities
    • refreshHostData
    • downloadService- palauttaa latauksen laajennetut tulostiedot.
    • eventService - palauttaa tietoja tapahtumien hahmontamisesta.
    • hostEnv
    • displayWarningIcon – palauttaa virheen tai varoitussanoman.
    • licenseManager – palauttaa käyttöoikeustiedot.
    • createLocalizationManager– luo esimiehen lokalisointia varten
    • applyJsonFilter - käyttää tiettyjä suodatintyyppejä. Katso Suodattimen ohjelmointirajapinta
    • applyCustomSort - sallii mukautetut lajitteluasetukset.
    • acquireAADTokenService – palauttaa Microsoft Entra ID - todennustiedot.
    • webAccessService– palauttaa etäresurssien käyttöoikeuksien tilan.
    • openModalDialog– palauttaa valintaikkunan.
    • persistProperties - käyttäjät voivat luoda pysyviä asetuksia ja tallentaa ne visualisoinnin määrityksen mukana, jolloin ne ovat käytettävissä seuraavassa uudelleenlatauksessa
    • eventService– palauttaa tapahtumapalvelun, joka tukee Hahmonna-tapahtumia
    • storageService– palauttaa palvelun, joka helpottaa paikallisen tallennustilan käyttöä visualisoinnissa
    • storageV2Service– palauttaa palvelun, joka helpottaa paikallisen tallennusversion 2 käyttämistä visualisoinnissa
    • tooltipService– palauttaa työkaluvihjepalvelun, joka helpottaa työkaluvihjeiden käyttöä visualisoinnissa
    • telemetry
    • drill
    • launchUrl – auttaa käynnistämään URL-osoitteen seuraavassa välilehdessä
    • authenticationService – palauttaa Microsoft Entra ID -tunnuksen.
    • locale – palauttaa aluekohtaisen merkkijonon; katso Lokalisointi
    • instanceId – palauttaa merkkijonon, jonka avulla visualisoinnin nykyinen esiintymä tunnistetaan
    • colorPalette – palauttaa väripaletin, jota tarvitaan värien käyttöön tiedoissa
    • fetchMoreData - tukee vakiorajaa (1 000 riviä) suuremman tietorajan käyttämistä. Katso Lisätietojen noutaminen
    • switchFocusModeState – auttaa muuttamaan kohdistustilaa

päivittää

Kaikkien visualisointien on käytettävä julkista päivitysmenetelmää, jota kutsutaan aina, kun tietoja tai isäntäympäristöä muutetaan.

public update(options: VisualUpdateOptions): void

VisualUpdateOptions

  • viewport: IViewport - sen näyttöraportin mitat, jossa visualisointi tulisi hahmontaa
  • dataViews: DataView[] – tietonäkymäobjekti, joka sisältää kaikki visualisoinnin hahmontamiseen tarvittavat tiedot (visualisointi käyttää yleensä DataView-kohdan alla olevaa luokittaista ominaisuutta)
  • type: VisualUpdateType- merkintä, joka ilmaisee päivitettävien tietojen tyypin (Tietojen | | ResizeEnd)
  • viewMode: ViewMode - merkintä, joka ilmaisee visualisoinnin näkymätilan (Näytä | Muokkaa | inFocusEdit)
  • editMode: EditMode- merkintä, joka ilmaisee visualisoinnin muokkaustilan (oletusasetukset | ) (jos visualisointi tukee AdvancedEditMode-tilaa, sen pitäisi hahmontaa käyttöliittymän lisäohjausobjektit vain, kun editMode-asetuksena on Lisäasetukset, katso AdvancedEditMode)
  • operationKind?: VisualDataChangeOperationKind- merkintä, joka ilmaisee tietojen muutoksen tyypin (Luo | lisä)
  • jsonFilters?: IFilter[] - kokoelma käytössä olevista json-suodattimista
  • isInFocus?: boolean – merkintä, joka ilmaisee, onko visualisointi kohdistustilassa

getFormattingModel (valinnainen)

Tätä menetelmää kutsutaan kerran aina, kun avaamme Ominaisuudet-ruudun tai käyttäjä muokkaa jotakin ruudun ominaisuuksista. Se palauttaa FormattingModel kaikki tiedot ominaisuusruudun rakenteesta, hierarkiasta, ominaisuuksista ja uusimmista muotoiluarvoista.

getFormattingModel(): visuals.FormattingModel;

destroy (valinnainen)

Destroy-funktiota kutsutaan, kun visualisointi puretaan, ja sitä voidaan käyttää tehtävien tyhjentämiseen, kuten tapahtumien kuuntelutoimintojen poistamiseen.

public destroy(): void

Vihje

Power BI ei tavallisesti kutsu -funktiota destroy , koska on nopeampaa poistaa koko IFrame, joka sisältää visualisoinnin.

Liittyvä sisältö