SPFx 1.19.0-beta.0

Author: Alex Terentiev

SP-Framework/breadcrumb/toc.yml

@@ -22,6 +22,7 @@ typeAliases:
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentConfiguration:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentEventNames:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentName:type'
+  - '@microsoft/sp-adaptive-card-extension-base!CardDataVisualizationKind:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardSearchBoxEventNames:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardSize:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardTextInputEventNames:type'
@@ -36,7 +37,10 @@ typeAliases:
   - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionIcon:type'
   - '@microsoft/sp-adaptive-card-extension-base!ICardAction:type'
   - '@microsoft/sp-adaptive-card-extension-base!IOnBeforeActionArguments:type'
+  - '@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!SupportedLineChartDataTypes:type'
 interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IActionError:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionActionView:interface'
@@ -45,9 +49,12 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface'
   - '@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!IBaseActionArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IBaseSeries:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBasicTextCardViewConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface'
@@ -59,6 +66,8 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!ICardButtonConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardButtonParameters:interface'
   - '@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!ICardSearchBoxButton:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxParameters:interface'
@@ -72,7 +81,11 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!ICardTextParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardViewConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardViewParameters:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICartesianChartParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IDataPoint:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewConfiguration:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IExecuteActionArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IExecuteCardAction:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IExecuteCardParameters:interface'
@@ -86,6 +99,8 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IImageCardViewConfiguration:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ILineChartCardViewConfiguration:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ILineChartSeries:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ILocation:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!INotificationArguments:interface'
@@ -156,6 +171,46 @@ functions:
       return:
         type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!ITextCardViewParameters:interface" />'
         description: ''
+  - name: LineChartCardView(configuration)
+    uid: '@microsoft/sp-adaptive-card-extension-base!LineChartCardView:function(1)'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    summary: Helper method to create a line chart card view with numeric data.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: >-
+        export declare function LineChartCardView(configuration: ILineChartCardViewConfiguration<number>):
+        IDataVisualizationCardViewParameters;
+      parameters:
+        - id: configuration
+          description: ''
+          type: >-
+            <xref uid="@microsoft/sp-adaptive-card-extension-base!ILineChartCardViewConfiguration:interface"
+            />&lt;number&gt;
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
+        description: ''
+  - name: LineChartCardView(configuration)
+    uid: '@microsoft/sp-adaptive-card-extension-base!LineChartCardView:function(2)'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    summary: Helper method to create a line chart card view with date data.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: >-
+        export declare function LineChartCardView(configuration: ILineChartCardViewConfiguration<Date>):
+        IDataVisualizationCardViewParameters;
+      parameters:
+        - id: configuration
+          description: ''
+          type: >-
+            <xref uid="@microsoft/sp-adaptive-card-extension-base!ILineChartCardViewConfiguration:interface"
+            />&lt;Date&gt;
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
+        description: ''
   - name: PrimaryTextCardView(configuration)
     uid: '@microsoft/sp-adaptive-card-extension-base!PrimaryTextCardView:function(1)'
     package: '@microsoft/sp-adaptive-card-extension-base!'

SP-Framework/office-ui-fabric-react-bundle.yml

@@ -8,5 +8,5 @@ remarks: ''
 isPreview: false
 isDeprecated: false
 syntax: >-
-  export declare type CardComponentName = 'text' | 'cardButton' | 'cardBar' | 'textInput' | 'searchBox' |
-  'searchFooter';
+  export declare type CardComponentName = 'text' | 'cardButton' | 'cardBar' | 'textInput' | 'searchBox' | 'searchFooter'
+  | 'dataVisualization';

SP-Framework/sp-adaptive-card-extension-base.yml

@@ -0,0 +1,10 @@
+### YamlMime:TSTypeAlias
+name: CardDataVisualizationKind
+uid: '@microsoft/sp-adaptive-card-extension-base!CardDataVisualizationKind:type'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: CardDataVisualizationKind
+summary: Supported data visualizations to render on the card view.
+remarks: ''
+isPreview: false
+isDeprecated: false
+syntax: export declare type CardDataVisualizationKind = 'line';

SP-Framework/sp-adaptive-card-extension-base/cardcomponentname.yml

@@ -9,4 +9,4 @@ isPreview: false
 isDeprecated: false
 syntax: >-
   export declare type ComponentsCardViewParameters = ITextCardViewParameters | ITextInputCardViewParameters |
-  ISearchCardViewParameters;
+  ISearchCardViewParameters | IDataVisualizationCardViewParameters;

SP-Framework/sp-adaptive-card-extension-base/carddatavisualizationkind.yml

@@ -0,0 +1,38 @@
+### YamlMime:TSType
+name: IAxis
+uid: '@microsoft/sp-adaptive-card-extension-base!IAxis:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: IAxis
+summary: Represents the parameters for an axis on a chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+  - name: formatter
+    uid: '@microsoft/sp-adaptive-card-extension-base!IAxis#formatter:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: formatter
+    summary: A function that formats the labels for the data points on the axis.
+    remarks: 'If no formatter is provided, a default formatter will be used.'
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'formatter?: (value: T) => string;'
+      return:
+        type: '(value: T) => string'
+  - name: labelValues
+    uid: '@microsoft/sp-adaptive-card-extension-base!IAxis#labelValues:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: labelValues
+    summary: An array of reference points to be represented as ticks on the axis.
+    remarks: >-
+      The number of data points is limited to ensure optimal display quality. The limit depends on the size of the card:
+      - Large Card: 2 to 6 data points for the x-axis - Medium Card: 2 to 3 data points for the x-axis - 2 to 4 data
+      points for the y-axis
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'labelValues?: T[];'
+      return:
+        type: 'T[]'

SP-Framework/sp-adaptive-card-extension-base/componentscardviewparameters.yml

@@ -0,0 +1,60 @@
+### YamlMime:TSType
+name: IBaseCardDataVisualizationParameters
+uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: IBaseCardDataVisualizationParameters
+summary: Base parameters for a data visualization component.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+  - name: ariaDescription
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters#ariaDescription:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: ariaDescription
+    summary: The 'aria-description' attribute for the data visualization component.
+    remarks: 'For example, "Line chart showing revenue by month from January to December".'
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'ariaDescription?: string;'
+      return:
+        type: string
+  - name: ariaLabel
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters#ariaLabel:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: ariaLabel
+    summary: The 'aria-label' attribute for the data visualization component.
+    remarks: 'For example, "Revenue by month".'
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'ariaLabel?: string;'
+      return:
+        type: string
+  - name: componentName
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters#componentName:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: componentName
+    summary: Unique component name.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'componentName: ''dataVisualization'';'
+      return:
+        type: '''dataVisualization'''
+  - name: dataVisualizationKind
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters#dataVisualizationKind:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: dataVisualizationKind
+    summary: Specifies the kind of the data visualization component.
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'dataVisualizationKind: CardDataVisualizationKind;'
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!CardDataVisualizationKind:type" />'
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!ICardComponentParameters:interface" />'

SP-Framework/sp-adaptive-card-extension-base/iaxis.yml

@@ -0,0 +1,23 @@
+### YamlMime:TSType
+name: IBaseSeries
+uid: '@microsoft/sp-adaptive-card-extension-base!IBaseSeries:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: IBaseSeries
+summary: Generic series for data visualization.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+  - name: name
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBaseSeries#name:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: name
+    summary: Name of the series.
+    remarks: Displayed in the legend.
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'name?: string;'
+      return:
+        type: string

SP-Framework/sp-adaptive-card-extension-base/ibasecarddatavisualizationparameters.yml

@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: ICardLineChartConfiguration
+uid: '@microsoft/sp-adaptive-card-extension-base!ICardLineChartConfiguration:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: ICardLineChartConfiguration
+summary: Configuration for a line chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+extends: >-
+  <xref uid="@microsoft/sp-adaptive-card-extension-base!CardComponentConfiguration:type" />&lt;<xref
+  uid="@microsoft/sp-adaptive-card-extension-base!ICardLineChartParameters:interface" />&lt;T&gt;&gt;

SP-Framework/sp-adaptive-card-extension-base/ibaseseries.yml

@@ -0,0 +1,38 @@
+### YamlMime:TSType
+name: ICardLineChartParameters
+uid: '@microsoft/sp-adaptive-card-extension-base!ICardLineChartParameters:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: ICardLineChartParameters
+summary: Parameters for a line chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+  - name: dataVisualizationKind
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardLineChartParameters#dataVisualizationKind:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: dataVisualizationKind
+    summary: Line chart
+    remarks: ''
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'dataVisualizationKind: ''line'';'
+      return:
+        type: '''line'''
+  - name: series
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardLineChartParameters#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: false
+    isDeprecated: false
+    syntax:
+      content: 'series: MaxThreeTuple<ILineChartSeries<T>>;'
+      return:
+        type: >-
+          <xref uid="@microsoft/sp-adaptive-card-extension-base!MaxThreeTuple:type" />&lt;<xref
+          uid="@microsoft/sp-adaptive-card-extension-base!ILineChartSeries:interface" />&lt;T&gt;&gt;
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!ICartesianChartParameters:interface" />&lt;T&gt;'

SP-Framework/sp-adaptive-card-extension-base/icardlinechartconfiguration.yml

@@ -0,0 +1,36 @@
+### YamlMime:TSType
+name: ICartesianChartParameters
+uid: '@microsoft/sp-adaptive-card-extension-base!ICartesianChartParameters:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: ICartesianChartParameters
+summary: Parameters for a Cartesian chart component with X and Y axes.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+  - name: xAxis
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICartesianChartParameters#xAxis:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: xAxis
+    summary: Parameters for the X axis of the chart.
+    remarks: 'This includes positions on xAxis to be represented as ticks, and a formatter function for the data point labels.'
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'xAxis?: IAxis<T>;'
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IAxis:interface" />&lt;T&gt;'
+  - name: yAxis
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICartesianChartParameters#yAxis:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: yAxis
+    summary: Parameters for the Y axis of the chart.
+    remarks: 'This includes positions on yAxis to be represented as ticks, and a formatter function for the data point labels.'
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'yAxis?: IAxis<number>;'
+      return:
+        type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IAxis:interface" />&lt;number&gt;'
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters:interface" />'