Työkaluvihjeiden apuohjelmat

Tämän artikkelin avulla voit asentaa, tuoda ja käyttää työkaluvihjeiden apuohjelmia. Tämä apuohjelma on hyödyllinen työkaluvihjeiden mukauttamiseen Power BI:n visualisoinneissa.

Edellytykset

Paketin käyttämiseen tarvitaan seuraavat asiat:

• Node.js (suosittelemme uusinta LTS:n versiota)
• npm (minimaalinen tuettu versio on 3.0.0)
• Kohteen luoma mukautettu visualisointi PowerBI-visuals-tools

Asennus

Jos haluat asentaa paketin, suorita seuraava komento hakemistossa, joka sisältää nykyisen visualisoinnin:

npm install powerbi-visuals-utils-tooltiputils --save

Tämä komento asentaa paketin ja lisää paketin riippuvuutena tiedostoosi package.json .

Käyttö

Käyttöopas kuvailee paketin julkisen ohjelmointirajapinnan. Löydät kuvauksen ja esimerkkejä paketin jokaisesta julkisesta liittymästä.

Tämän paketin avulla voit luoda TooltipServiceWrapper ja menetelmiä, jotka auttavat työkaluvihjetoimintojen käsittelemisessä. Se käyttää työkaluvihjeliittymiä – ITooltipServiceWrapper, TooltipEventArgs, TooltipEnabledDataPoint.

Se sisältää tiettyjä menetelmiä (kosketustapahtumien käsittelijöitä), jotka liittyvät mobiilikehitykseen: touchEndEventName, touchStartEventName, usePointerEvents.

TooltipServiceWrapper tarjoaa helpoimman tavan käsitellä työkaluvihjeitä.

Tämä moduuli sisältää seuraavan liittymän ja toiminnon:

• ITooltipServiceWrapper

  • addTooltip
  • piilottaa

• Liitännät

  • TooltipEventArgs
  • TooltipEnabledDataPoint
  • TooltipServiceWrapperOptions

• Kosketustapahtumat

createTooltipServiceWrapper

Tämä funktio luo -esiintymän ITooltipServiceWrapper.

function createTooltipServiceWrapper(tooltipService: ITooltipService, rootElement: Element, handleTouchDelay?: number,  getEventMethod?: () => MouseEvent): ITooltipServiceWrapper;

ITooltipService on käytettävissä IVisualHost-kohteessa.

Esimerkki:

import { createTooltipServiceWrapper } from "powerbi-visuals-utils-tooltiputils";

export class YourVisual implements IVisual {
    // implementation of IVisual.

    constructor(options: VisualConstructorOptions) {
        createTooltipServiceWrapper(
            options.host.tooltipService,
            options.element);

        // returns: an instance of ITooltipServiceWrapper.
    }
}

Katso esimerkki mukautetusta visualisoinnista tästä.

ITooltipServiceWrapper

Tämä liittymä kuvaa TooltipServicen julkisia menetelmiä.

interface ITooltipServiceWrapper {
    addTooltip<T>(selection: d3.Selection<any, any, any, any>, getTooltipInfoDelegate: (args: TooltipEventArgs<T>) => powerbi.extensibility.VisualTooltipDataItem[], getDataPointIdentity?: (args: TooltipEventArgs<T>) => powerbi.visuals.ISelectionId, reloadTooltipDataOnMouseMove?: boolean): void;
    hide(): void;
}

ITooltipServiceWrapper.addTooltip

Tämä menetelmä lisää työkaluvihjeitä nykyiseen valintaan.

addTooltip<T>(selection: d3.Selection<any>, getTooltipInfoDelegate: (args: TooltipEventArgs<T>) => VisualTooltipDataItem[], getDataPointIdentity?: (args: TooltipEventArgs<T>) => ISelectionId, reloadTooltipDataOnMouseMove?: boolean): void;

Esimerkki:

import { createTooltipServiceWrapper, TooltipEventArgs, ITooltipServiceWrapper, TooltipEnabledDataPoint } from "powerbi-visuals-utils-tooltiputils";

let bodyElement = d3.select("body");

let element = bodyElement
    .append("div")
    .style({
        "background-color": "green",
        "width": "150px",
        "height": "150px"
    })
    .classed("visual", true)
    .data([{
        tooltipInfo: [{
            displayName: "Power BI",
            value: 2016
        }]
    }]);

let tooltipServiceWrapper: ITooltipServiceWrapper = createTooltipServiceWrapper(tooltipService, bodyElement.get(0)); // tooltipService is from the IVisualHost.

tooltipServiceWrapper.addTooltip<TooltipEnabledDataPoint>(element, (eventArgs: TooltipEventArgs<TooltipEnabledDataPoint>) => {
    return eventArgs.data.tooltipInfo;
});

// You will see a tooltip if you mouseover the element.

Katso esimerkki mukautetusta visualisoinnista tästä.

Katso esimerkki työkaluvihjeen mukauttamisesta mukautetussa Gantt-visualisoinnissa tästä.

ITooltipServiceWrapper.hide

Tämä menetelmä piilottaa työkaluvihjeen.

hide(): void;

Esimerkki:

import {createTooltipServiceWrapper} from "powerbi-visuals-utils-tooltiputils";

let tooltipServiceWrapper = createTooltipServiceWrapper(options.host.tooltipService, options.element); // options are from the VisualConstructorOptions.

tooltipServiceWrapper.hide();

Interfaces

Liittymiä käytetään TooltipServiceWrapperin luonnin ja käytön aikana. Ne mainittiin aiempien artikkeleiden esimerkeissä täällä.

TooltipEventArgs

interface TooltipEventArgs<TData> {
    data: TData;
    coordinates: number[];
    elementCoordinates: number[];
    context: HTMLElement;
    isTouchEvent: boolean;
}

TooltipEnabledDataPoint

interface TooltipEnabledDataPoint {
    tooltipInfo?: powerbi.extensibility.VisualTooltipDataItem[];
}

TooltipServiceWrapperOptions

interface TooltipServiceWrapperOptions {
    tooltipService: ITooltipService;
    rootElement: Element;
    handleTouchDelay: number;

Touch events

Työkaluvihjeiden apuohjelmat pystyvät nyt käsittelemään useita mobiilikehityksen kannalta hyödyllisiä kosketustapahtumia.

touchStartEventName

function touchStartEventName(): string

Tämä menetelmä palauttaa kosketuksen aloitustapahtuman nimen.

touchEndEventName

function touchEndEventName(): string

Tämä menetelmä palauttaa kosketuspääsytapahtuman nimen.

usePointerEvents

function usePointerEvents(): boolean

Tämä menetelmä palauttaa nykyisen touchStart-tapahtuman, joka liittyy tai ei ole suhteessa osoittimeen.