add bar and pie chart API

Alex Terentiev · Alex Terentiev · commit 274838f98d94 · 2024-08-14T12:22:38.000-04:00
diff --git a/SP-Framework/sp-adaptive-card-extension-base.yml b/SP-Framework/sp-adaptive-card-extension-base.yml
@@ -20,6 +20,7 @@ classes:
   - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class'
   - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class'
 typeAliases:
+  - '@microsoft/sp-adaptive-card-extension-base!BarChartData:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentConfiguration:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentEventNames:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentName:type'
@@ -41,6 +42,7 @@ typeAliases:
   - '@microsoft/sp-adaptive-card-extension-base!LineChartData:type'
   - '@microsoft/sp-adaptive-card-extension-base!MaxThreeTuple:type'
   - '@microsoft/sp-adaptive-card-extension-base!RenderType:type'
+  - '@microsoft/sp-adaptive-card-extension-base!SupportedBarChartDataTypes:type'
   - '@microsoft/sp-adaptive-card-extension-base!SupportedLineChartDataTypes:type'
 interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IActionError:interface'
@@ -51,6 +53,8 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IAxis:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IBarChartSeries:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters:interface'
@@ -60,6 +64,8 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IBasicTextCardViewConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICardBarChartParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardBarConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardBarParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface'
@@ -69,6 +75,8 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!ICardComponentParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardLineChartConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardLineChartParameters:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICardPieChartConfiguration:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICardPieChartParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxButton:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxParameters:interface'
@@ -110,6 +118,9 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IPartialSDKs:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsContext:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsJs:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IPieChartCardViewConfiguration:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IPieChartSeries:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IPieDataPoint:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardViewConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IQuickViewActionArguments:interface'
@@ -140,6 +151,66 @@ interfaces:
 enums:
   - '@microsoft/sp-adaptive-card-extension-base!MediaType:enum'
 functions:
+  - name: BarChartCardView(configuration)
+    uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(1)'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    summary: Helper method to create a bar chart card view with numeric data.
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: >-
+        export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<number>):
+        IDataVisualizationCardViewParameters;
+      parameters:
+        - id: configuration
+          description: ''
+          type: >-
+            <xref uid="@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface"
+            />&lt;number&gt;
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
+        description: ''
+  - name: BarChartCardView(configuration)
+    uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(2)'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    summary: Helper method to create a bar chart card view with string data.
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: >-
+        export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<string>):
+        IDataVisualizationCardViewParameters;
+      parameters:
+        - id: configuration
+          description: ''
+          type: >-
+            <xref uid="@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface"
+            />&lt;string&gt;
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
+        description: ''
+  - name: BarChartCardView(configuration)
+    uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(3)'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    summary: Helper method to create a bar chart card view with date data.
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: >-
+        export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<Date>):
+        IDataVisualizationCardViewParameters;
+      parameters:
+        - id: configuration
+          description: ''
+          type: >-
+            <xref uid="@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface"
+            />&lt;Date&gt;
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
+        description: ''
   - name: BasicCardView(configuration)
     uid: '@microsoft/sp-adaptive-card-extension-base!BasicCardView:function(1)'
     package: '@microsoft/sp-adaptive-card-extension-base!'
@@ -212,6 +283,24 @@ functions:
       return:
         type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
         description: ''
+  - name: PieChartCardView(configuration)
+    uid: '@microsoft/sp-adaptive-card-extension-base!PieChartCardView:function(1)'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    summary: Helper method to create a pie chart card view
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: >-
+        export declare function PieChartCardView(configuration: IPieChartCardViewConfiguration):
+        IDataVisualizationCardViewParameters;
+      parameters:
+        - id: configuration
+          description: pie chart card view configuration.
+          type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IPieChartCardViewConfiguration:interface" />'
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
+        description: pie chart card view parameters.
   - name: PrimaryTextCardView(configuration)
     uid: '@microsoft/sp-adaptive-card-extension-base!PrimaryTextCardView:function(1)'
     package: '@microsoft/sp-adaptive-card-extension-base!'
diff --git a/SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml b/SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml
@@ -0,0 +1,12 @@
+### YamlMime:TSTypeAlias
+name: BarChartData
+uid: '@microsoft/sp-adaptive-card-extension-base!BarChartData:type'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: BarChartData
+summary: Utility type to define what valid types of data can be used in a bar chart data visualization.
+remarks: >-
+  See [SupportedBarChartDataTypes](xref:@microsoft/sp-adaptive-card-extension-base!SupportedBarChartDataTypes:type) for
+  valid types.
+isPreview: true
+isDeprecated: false
+syntax: 'export type BarChartData<Type> = ExtractFromSet<SupportedBarChartDataTypes, Type>;'
diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibarchartcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/ibarchartcardviewconfiguration.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: IBarChartCardViewConfiguration
+uid: '@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: IBarChartCardViewConfiguration
+summary: Configuration for a bar chart card view.
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+  - name: body
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration#body:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: body
+    summary: Body area components.
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: >-
+        body: ICardBarChartConfiguration<T> | [ICardBarChartConfiguration<T>] | [ICardTextConfiguration,
+        ICardBarChartConfiguration<T>];
+      return:
+        type: >-
+          <xref uid="@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface" />&lt;T&gt; |
+          [<xref uid="@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface" />&lt;T&gt;] |
+          [<xref uid="@microsoft/sp-adaptive-card-extension-base!ICardTextConfiguration:interface" />, <xref
+          uid="@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface" />&lt;T&gt;]
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewConfiguration:interface" />'
diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibarchartseries.yml b/SP-Framework/sp-adaptive-card-extension-base/ibarchartseries.yml
@@ -0,0 +1,39 @@
+### YamlMime:TSType
+name: IBarChartSeries
+uid: '@microsoft/sp-adaptive-card-extension-base!IBarChartSeries:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: IBarChartSeries
+summary: Series for a bar chart.
+remarks: >-
+  The number of points rendered on the x-axis is predefined: - Large Chart: Limited to five points (displayed when a
+  card view contains no more than three components). - Medium Chart: Limited to three points for a single series and two
+  points for multiple series.
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+  - name: color
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBarChartSeries#color:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: color
+    summary: Color of the series.
+    remarks: 'If not provided, a color will be automatically assigned.'
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'color?: string;'
+      return:
+        type: string
+  - name: data
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBarChartSeries#data:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: data
+    summary: Data for the series.
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'data: IDataPoint<T>[];'
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataPoint:interface" />&lt;T&gt;[]'
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IBaseSeries:interface" />'
diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbarchartconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbarchartconfiguration.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: ICardBarChartConfiguration
+uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: ICardBarChartConfiguration
+summary: Configuration for a bar chart.
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+extends: >-
+  <xref uid="@microsoft/sp-adaptive-card-extension-base!CardComponentConfiguration:type" />&lt;<xref
+  uid="@microsoft/sp-adaptive-card-extension-base!ICardBarChartParameters:interface" />&lt;T&gt;&gt;
diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbarchartparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbarchartparameters.yml
@@ -0,0 +1,50 @@
+### YamlMime:TSType
+name: ICardBarChartParameters
+uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarChartParameters:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: ICardBarChartParameters
+summary: Parameters for a bar chart.
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+  - name: dataVisualizationKind
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarChartParameters#dataVisualizationKind:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: dataVisualizationKind
+    summary: Bar chart
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'dataVisualizationKind: ''bar'';'
+      return:
+        type: '''bar'''
+  - name: series
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarChartParameters#series:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: series
+    summary: Series to display.
+    remarks: Can be a single series or multiple (upto 3) series.
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'series: MaxThreeTuple<IBarChartSeries<T>>;'
+      return:
+        type: >-
+          <xref uid="@microsoft/sp-adaptive-card-extension-base!MaxThreeTuple:type" />&lt;<xref
+          uid="@microsoft/sp-adaptive-card-extension-base!IBarChartSeries:interface" />&lt;T&gt;&gt;
+  - name: showDataLabels
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarChartParameters#showDataLabels:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: showDataLabels
+    summary: Flag to indicate if data labels need to be shown or not.
+    remarks: Default value is false
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'showDataLabels?: boolean;'
+      return:
+        type: boolean
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!ICartesianChartParameters:interface" />&lt;T&gt;'
diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardpiechartconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/icardpiechartconfiguration.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: ICardPieChartConfiguration
+uid: '@microsoft/sp-adaptive-card-extension-base!ICardPieChartConfiguration:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: ICardPieChartConfiguration
+summary: Configuration for a pie chart.
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+extends: >-
+  <xref uid="@microsoft/sp-adaptive-card-extension-base!CardComponentConfiguration:type" />&lt;<xref
+  uid="@microsoft/sp-adaptive-card-extension-base!ICardPieChartParameters:interface" />&gt;
diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardpiechartparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardpiechartparameters.yml
@@ -0,0 +1,48 @@
+### YamlMime:TSType
+name: ICardPieChartParameters
+uid: '@microsoft/sp-adaptive-card-extension-base!ICardPieChartParameters:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: ICardPieChartParameters
+summary: Parameters for a pie chart.
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+  - name: dataVisualizationKind
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardPieChartParameters#dataVisualizationKind:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: dataVisualizationKind
+    summary: Pie chart
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'dataVisualizationKind: ''pie'';'
+      return:
+        type: '''pie'''
+  - name: isDonut
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardPieChartParameters#isDonut:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: isDonut
+    summary: Flag to indicate if the pie chart should be rendered as a donut chart.
+    remarks: false by default. Renders as a donut chart if true.
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'isDonut?: boolean;'
+      return:
+        type: boolean
+  - name: series
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardPieChartParameters#series:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: series
+    summary: Series to display.
+    remarks: Should be a single series.
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'series: [IPieChartSeries];'
+      return:
+        type: '[<xref uid="@microsoft/sp-adaptive-card-extension-base!IPieChartSeries:interface" />]'
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters:interface" />'
diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipiechartcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/ipiechartcardviewconfiguration.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: IPieChartCardViewConfiguration
+uid: '@microsoft/sp-adaptive-card-extension-base!IPieChartCardViewConfiguration:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: IPieChartCardViewConfiguration
+summary: Configuration for a pie chart card view.
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+  - name: body
+    uid: '@microsoft/sp-adaptive-card-extension-base!IPieChartCardViewConfiguration#body:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: body
+    summary: Body area components.
+    remarks: ''
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: >-
+        body: ICardPieChartConfiguration | [ICardPieChartConfiguration] | [ICardTextConfiguration,
+        ICardPieChartConfiguration];
+      return:
+        type: >-
+          <xref uid="@microsoft/sp-adaptive-card-extension-base!ICardPieChartConfiguration:interface" /> | [<xref
+          uid="@microsoft/sp-adaptive-card-extension-base!ICardPieChartConfiguration:interface" />] | [<xref
+          uid="@microsoft/sp-adaptive-card-extension-base!ICardTextConfiguration:interface" />, <xref
+          uid="@microsoft/sp-adaptive-card-extension-base!ICardPieChartConfiguration:interface" />]
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewConfiguration:interface" />'
diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipiechartseries.yml b/SP-Framework/sp-adaptive-card-extension-base/ipiechartseries.yml
diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipiedatapoint.yml b/SP-Framework/sp-adaptive-card-extension-base/ipiedatapoint.yml
diff --git a/SP-Framework/sp-adaptive-card-extension-base/supportedbarchartdatatypes.yml b/SP-Framework/sp-adaptive-card-extension-base/supportedbarchartdatatypes.yml
diff --git a/SP-Framework/toc.yml b/SP-Framework/toc.yml
