Görsel API

  • Makale

Tüm görseller arabirimini uygulayan IVisual bir sınıfla başlar. Arabirimini uygulayan tam olarak bir sınıf olduğu sürece sınıfı her IVisual şeyi adlandırabilirsiniz.

Not

Görsel sınıf adı dosyadaki pbiviz.json ile visualClassName aynı olmalıdır.

Görsel sınıfı, aşağıdaki örnekte gösterildiği gibi aşağıdaki yöntemleri uygulamalıdır:

  • constructor - görselin durumunu başlatan standart bir oluşturucu
  • update - görselin verilerini güncelleştirir
  • getFormattingModel, özellikleri gerektiği gibi değiştirebileceğiniz özellik bölmesini (biçimlendirme seçenekleri) dolduran bir biçimlendirme modeli döndürür
  • destroy - temizleme için standart bir yıkıcı
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)
    }
}

oluşturucusu

constructor Görsel örneği oluşturulurken görsel sınıfının adı çağrılır. Görselin ihtiyaç duyduğu tüm kurulum işlemleri için kullanılabilir.

constructor(options: VisualConstructorOptions)

VisualConstructorOptions

Bu arabirimler her yeni API sürümüyle güncelleştirilir. En güncel arabirim biçimi için GitHub depomuza gidin.

Aşağıdaki listede arabirimin bazı özellikleri VisualConstructorOptions açıklanmaktadır:

  • element: HTMLElement - görselinizi içeren DOM öğesine başvuru

  • host: IVisualHost - görsel ana bilgisayarla etkileşime geçmek için kullanılabilecek özellikler ve hizmetler koleksiyonu (Power BI)

    IVisualHost aşağıdaki hizmetleri içerir:

    • createSelectionIdBuilder - Görselinizde seçilebilir öğeler için meta veriler oluşturur ve depolar
    • createSelectionManager - görselin konağına seçim durumundaki değişiklikleri bildirmek için kullanılan iletişim köprüsünü oluşturur, bkz . Seçim API'si.
    • hostCapabilities
    • refreshHostData
    • downloadService- indirme işleminin genişletilmiş sonuç bilgilerini döndürür.
    • eventService- olayları işleme hakkında bilgi döndürür.
    • hostEnv
    • displayWarningIcon- hata veya uyarı iletisi döndürür.
    • licenseManager- lisans bilgilerini döndürür.
    • createLocalizationManager - Yerelleştirmeye yardımcı olması için bir yönetici oluşturur
    • applyJsonFilter - belirli filtre türlerini uygular. Bkz. Filtre API'si
    • applyCustomSort- özel sıralama seçeneklerine izin verir.
    • acquireAADTokenService - Microsoft Entra Id kimlik doğrulama bilgilerini döndürür.
    • webAccessService- uzak kaynaklara erişmek için izin durumunu döndürür.
    • openModalDialog - bir iletişim kutusu döndürür.
    • persistProperties - kullanıcıların kalıcı ayarlar oluşturmasına ve bunları görsel tanımıyla birlikte kaydetmesine olanak tanır, böylece bir sonraki yeniden yüklemede kullanılabilirler
    • eventService- İşleme olaylarını desteklemek için bir olay hizmeti döndürür
    • storageService- görselde yerel depolamanın kullanılmasına yardımcı olacak bir hizmet döndürür
    • storageV2Service- görselde yerel depolama sürüm 2'yi kullanmaya yardımcı olacak bir hizmet döndürür
    • tooltipService - görselde araç ipuçlarının kullanılmasına yardımcı olmak için bir araç ipucu hizmeti döndürür
    • telemetry
    • drill
    • launchUrl- sonraki sekmede URL'yi başlatmaya yardımcı olur
    • authenticationService - Bir Microsoft Entra Id belirteci döndürür.
    • locale - bir yerel ayar dizesi döndürür, bkz. Yerelleştirme
    • instanceId - geçerli görsel örneği tanımlamak için bir dize döndürür
    • colorPalette - verilerinize renk uygulamak için gereken colorPalette değerini verir
    • fetchMoreData - standart sınırdan (1.000 satır) daha fazla veri kullanmayı destekler. Bkz. Daha fazla veri getirme
    • switchFocusModeState - odak modu durumunu değiştirmeye yardımcı olur

update

Tüm görseller, veri veya konak ortamında her değişiklik olduğunda çağrılan bir genel güncelleştirme yöntemi uygulamalıdır.

public update(options: VisualUpdateOptions): void

VisualUpdateOptions

  • viewport: IViewport - görselin içinde işlenmesi gereken görünüm penceresi boyutları
  • dataViews: DataView[] - görselinizi işlemek için gereken tüm verileri içeren veri görünümü nesnesi (görsel genellikle DataView altındaki kategorik özelliği kullanır)
  • type: VisualUpdateType- güncelleştirilmekte olan veri türünü gösteren bayraklar (Veri | Yeniden Boyutlandırma | ViewMode | Stili | ResizeEnd)
  • viewMode: ViewMode- görselin görünüm modunu gösteren bayraklar (Görünüm | Düzenleme | InFocusEdit)
  • editMode: EditMode- görselin düzenleme modunu gösteren bayrak (Varsayılan | Gelişmiş) (görsel AdvancedEditMode'yi destekliyorsa, yalnızca editMode Gelişmiş olarak ayarlandığında gelişmiş UI denetimlerini işlemelidir, bkz. AdvancedEditMode)
  • operationKind?: VisualDataChangeOperationKind- Veri değişikliği türünü gösteren bayrak (Ekleme Oluştur | )
  • jsonFilters?: IFilter[] - uygulanan json filtrelerinin toplanması
  • isInFocus?: boolean - görselin odak modunda olup olmadığını gösteren bayrak

getFormattingModel (isteğe bağlı)

Bu yöntem, özellikler bölmesini her açışımızda veya kullanıcı bölmedeki özelliklerden herhangi birini düzenleyişimizde çağrılır. Özellikler bölmesi tasarımı, hiyerarşisi, özellikleri ve en son biçimlendirme değerleriyle ilgili tüm bilgileri döndürür FormattingModel .

getFormattingModel(): visuals.FormattingModel;

destroy (isteğe bağlı)

Görseliniz kaldırıldığında destroy işlevi çağrılır ve olay dinleyicilerini kaldırma gibi temizleme görevleri için kullanılabilir.

public destroy(): void

İpucu

Görseli içeren IFrame'in tamamını kaldırmak daha hızlı olduğundan Power BI genellikle çağrı destroy yapmaz.

İlgili içerik