警告の表示アイコンを視覚エフェクトに追加する

Power BI 視覚エフェクトでは、警告の表示アイコンを使用して、問題またはエラーの可能性をユーザーに通知することができます。 警告の表示アイコンは、次のような多くの場合に役立ちます。

• 値が緯度または経度の有効範囲から外れている場合は、マップの視覚エフェクトに警告アイコンを表示することができます。

• 円グラフの視覚エフェクトには、負の値と正の値が混在して表示されているときに警告アイコンを表示できます。

• デカルト グラフには、無限大の値が計算されるときに警告アイコンを表示できます。 たとえば、Y がゼロの場合、X を Y で割ると、結果は無限大になります。

アイコンが表示されている場合、ユーザーがアイコンにカーソルを合わせると、警告メッセージのタイトルが表示されます。

ユーザーが警告アイコンを選ぶと、問題を説明するメッセージがポップアップ ウィンドウに表示されます。

警告アイコンを作成する

警告アイコンと、カスタムの視覚エフェクト用にカスタマイズされたメッセージを作成できます。 警告アイコンを表示するかどうかは、任意で指定できます。 これらの例で示されているように、警告アイコンが表示されても、視覚エフェクトは引き続き機能します。

update メソッドへの呼び出しを追加する

視覚エフェクトに警告の表示アイコンを追加するには、displayWarningIcon メソッドを呼び出します。 メソッドは IVisualHost の一部であり、powerbi-visuals-api を使用して公開されています。

次のインポートをファイルに追加します。

import powerbiVisualsApi from "powerbi-visuals-api"; 

インポートを追加した後、警告アイコンをいつ表示するかを決定する条件を追加します。 この記事の例を使って、2 つの省略可能な条件を表示します。

例 1: 言語の互換性を確認する

ローカライズは、オペレーティング システムの設定によって決定される顧客の母国語で視覚エフェクトを表示するために使用されます。

この例では、視覚エフェクトにより、視覚エフェクトの言語 (米国英語に設定されています) とオペレーティング システムの言語が比較されています。 言語が一致しない場合は、警告アイコンが表示されます。

if (this.locale != 'en-US') { 

            this.host.displayWarningIcon('Language inconsistency', 'This visual supports only US English. For the visual to work as expected, set your browser's language to US English.'); 
        }

例 2: 隣接する列の色を比較する

この例では、隣接する 2 つの列の色が同じである場合に、警告の表示アイコンが表示されます。

getColumnColorByIndex メソッドにより、すべての列が反復処理されます。 隣接する 2 つの列の色が同じ場合、警告アイコンが表示されます。

let category = options.dataViews[0].categorical.categories[0]; 

let dataValue = options.dataViews[0].categorical.values[0]; 

let colorPalette = this.host.colorPalette; 

for (let i = 0, len = Math.max(category.values.length, dataValue.values.length); i < len-1; i++) { 

    const color1: string = getColumnColorByIndex(category, i, colorPalette); 

    const color2: string = getColumnColorByIndex(category, i+1, colorPalette); 

    if (color1 == color2) { 

        this.host.displayWarningIcon('Adjacent columns have the same color.', 'Columns that are next to each other have the same color. To change a column's color, use the data colors option in the Format tab.'); 
    } 

} 

考慮事項と制限事項

• 視覚エフェクトが原因ではないエラーと警告もあります。 たとえば、"値が多すぎます。一部のデータは表示されていません" エラーは Power BI サービスから生成されます。 このようなエラーと警告は、視覚エフェクトの呼び出しの前に伝達されます。 これらは視覚エフェクトのコードに起因するエラーよりも優先されます。 データの読み込み中にエラーが発生した場合、視覚エフェクトのコードが実行され、警告の表示アイコンの条件が満たされる前に、視覚エフェクトには警告の表示アイコン エラーではなくそのエラーが表示されます。

• 警告の表示は、視覚エフェクトのレンダリングのたびにクリアされます。たとえば、新しいデータが視覚エフェクトにドラッグされたときなどです。 視覚エフェクトの update() メソッドは、視覚エフェクトがレンダリングされた後に呼び出されます。 update メソッドで確認された条件に基づいて視覚エフェクトの警告が発生した場合、視覚エフェクトがレンダリングされるたびに、条件を満たしていると視覚エフェクトに警告がもう一度表示されます。

• 視覚エフェクトのサイズを変更しても、警告アイコンには影響しません。

表示アイコンのテキストについて、次の制限事項があります。

• タイトルの最大長は 70 文字です

• テキストの最大長は 2,000 文字です

• テキストはプレーン テキストとしてのみ表示されます

関連するコンテンツ

DataViewUtils