Power BI ビジュアルの分析ウィンドウThe Analytics pane in Power BI visuals

2018 年 11 月に、分析ウィンドウがネイティブ ビジュアルに導入されました。The Analytics pane was introduced for native visuals in November 2018. この記事では、API v2.5.0 を使用する Power BI ビジュアルで分析ウィンドウにそれらのプロパティを表示して管理する方法について検討します。This article discusses how Power BI visuals with API v2.5.0 can present and manage their properties in the Analytics pane.

分析ウィンドウ

分析ウィンドウを管理するManage the Analytics pane

書式ウィンドウでプロパティを管理するように、ビジュアルの capabilities.json ファイルでオブジェクトを定義することで、分析ウィンドウを管理します。Just as you'd manage properties in the Format pane, you manage the Analytics pane by defining an object in the visual's capabilities.json file.

分析ウィンドウでは、次のような違いがあります。For the Analytics pane, the differences are as follows:

  • オブジェクトの定義で、値が 2 の objectCategory フィールドを追加します。Under the object's definition, you add an objectCategory field with a value of 2.

    注意

    省略可能な objectCategory フィールドは、API 2.5.0 で導入されました。The optional objectCategory field was introduced in API 2.5.0. オブジェクトによって制御されるビジュアルの側面が定義されます (1 = 書式設定、2 = 分析)。It defines the aspect of the visual that the object controls (1 = Formatting, 2 = Analytics). Formatting は、外観、色、軸、ラベルなどの要素に使用されます。Formatting is used for such elements as look and feel, colors, axes, and labels. Analytics は、予測、近似曲線、参照行、図形などの要素に使用されます。Analytics is used for such elements as forecasts, trendlines, reference lines, and shapes.

    値が指定されていない場合、objectCategory は既定で "書式設定" になります。If the value isn't specified, objectCategory defaults to "Formatting."

  • オブジェクトには、次の 2 つのプロパティが必要です。The object must have the following two properties:

    • bool 型の show。既定値は false です。show of type bool, with a default value of false.
    • text 型の displayNamedisplayName of type text. 選択する既定値が、インスタンスの最初の表示名になります。The default value that you choose becomes the instance's initial display name.
{
  "objects": {
    "YourAnalyticsPropertiesCard": {
      "displayName": "Your analytics properties card's name",
      "objectCategory": 2,
      "properties": {
        "show": {
          "type": {
            "bool": true
          }
        },
        "displayName": {
          "type": {
            "text": true
          }
        },
      ... //any other properties for your Analytics card
      }
    }
  ...
  }
}

他のプロパティは、書式オブジェクトの場合と同じ方法で定義できます。You can define other properties in the same way that you do for Format objects. また、書式ウィンドウの場合と同様に、オブジェクトを列挙することもできます。And you can enumerate objects just as you do in the Format pane.

分析ウィンドウの既知の制限事項と問題Known limitations and issues of the Analytics pane

  • 分析ウィンドウでは、まだマルチインスタンスはサポートされていません。The Analytics pane has no multi-instance support yet. オブジェクトに静的以外のセレクターを含めることはできません (つまり、"selector": null)。また、Power BI ビジュアルでは、ユーザー定義の複数のカード インスタンスを含めることはできません。Objects can't have a selector other than static (that is, "selector": null), and Power BI visuals can't have user-defined multiple instances of a card.
  • integer 型のプロパティが正しく表示されません。Properties of type integer aren't displayed correctly. 回避策として、代わりに numeric 型を使用します。As a workaround, use type numeric instead.

注意

  • 分析ウィンドウは、新しい情報を追加するか、表示された情報に新たな光を当てるオブジェクトに対してのみ使用します (たとえば、重要な傾向を示す動的な参照行)。Use the Analytics pane only for objects that add new information or shed new light on the presented information (for example, dynamic reference lines that illustrate important trends).
  • ビジュアルの外観 (つまり、書式設定) を制御するオプションはすべて、書式設定ウィンドウに限定する必要があります。Any options that control the look and feel of the visual (that is, formatting) should be limited to the Formatting pane.