Update with latest type definitions (#307)

AlexJerabek · web-flow · commit ff5eec4bbe88 · 2023-12-05T13:21:53.000-08:00
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatasourcetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatasourcetype.yml
@@ -3,24 +3,24 @@ name: ExcelScript.ChartDataSourceType
 uid: 'ExcelScript!ExcelScript.ChartDataSourceType:enum'
 package: ExcelScript!
 fullName: ExcelScript.ChartDataSourceType
-summary: 'Specifies whether the series data range is local range, external range, list, or unknown.'
+summary: Specifies the data source type of the chart series.
 remarks: ''
 isPreview: false
 isDeprecated: false
 fields:
   - name: externalRange
     uid: 'ExcelScript!ExcelScript.ChartDataSourceType.externalRange:member'
     package: ExcelScript!
-    summary: ''
+    summary: The data source type of the chart series is an external range.
   - name: list
     uid: 'ExcelScript!ExcelScript.ChartDataSourceType.list:member'
     package: ExcelScript!
-    summary: ''
+    summary: The data source type of the chart series is a list.
   - name: localRange
     uid: 'ExcelScript!ExcelScript.ChartDataSourceType.localRange:member'
     package: ExcelScript!
-    summary: ''
+    summary: The data source type of the chart series is a local range.
   - name: unknown
     uid: 'ExcelScript!ExcelScript.ChartDataSourceType.unknown:member'
     package: ExcelScript!
-    summary: ''
+    summary: The data source type of the chart series is unknown or unsupported.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml
@@ -174,7 +174,7 @@ methods:
     package: ExcelScript!
     fullName: getDimensionDataSourceString(dimension)
     summary: >-
-      Gets the string representation of the data source of the chart series.The string representation could be
+      Gets the string representation of the data source of the chart series. The string representation could be
       information such as a cell address.
     remarks: ''
     isPreview: false
@@ -1521,7 +1521,7 @@ methods:
     uid: 'ExcelScript!ExcelScript.ChartSeries#setXAxisValues:member(1)'
     package: ExcelScript!
     fullName: setXAxisValues(sourceData)
-    summary: Sets the values of the x-axis for a chart series. Only works for scatter charts.
+    summary: Sets the values of the x-axis for a chart series.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.insertshiftdirection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.insertshiftdirection.yml
@@ -3,7 +3,7 @@ name: ExcelScript.InsertShiftDirection
 uid: 'ExcelScript!ExcelScript.InsertShiftDirection:enum'
 package: ExcelScript!
 fullName: ExcelScript.InsertShiftDirection
-summary: ''
+summary: Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
 remarks: |-
 
 
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditem.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditem.yml
@@ -172,7 +172,9 @@ methods:
     uid: 'ExcelScript!ExcelScript.NamedItem#getValue:member(1)'
     package: ExcelScript!
     fullName: getValue()
-    summary: 'Represents the value computed by the name''s formula. For a named range, will return the range address.'
+    summary: >-
+      Represents the value computed by the name's formula. For a named range, it will return the range address. This API
+      returns the \#VALUE! error in the Excel UI if it refers to a user-defined function.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml
@@ -91,7 +91,7 @@ methods:
         - id: destinationRange
           description: >-
             The destination range to AutoFill. If the destination range is `null`<!-- -->, data is filled out based on
-            the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle).
+            the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
           type: '<xref uid="ExcelScript!ExcelScript.Range:interface" /> | string'
         - id: autoFillType
           description: >-
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangecopytype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangecopytype.yml
@@ -40,6 +40,10 @@ fields:
     uid: 'ExcelScript!ExcelScript.RangeCopyType.all:member'
     package: ExcelScript!
     summary: ''
+  - name: columnWidths
+    uid: 'ExcelScript!ExcelScript.RangeCopyType.columnWidths:member'
+    package: ExcelScript!
+    summary: ''
   - name: formats
     uid: 'ExcelScript!ExcelScript.RangeCopyType.formats:member'
     package: ExcelScript!
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sorton.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sorton.yml
@@ -3,7 +3,7 @@ name: ExcelScript.SortOn
 uid: 'ExcelScript!ExcelScript.SortOn:enum'
 package: ExcelScript!
 fullName: ExcelScript.SortOn
-summary: ''
+summary: Represents the part of the cell used as the sorting criteria.
 remarks: |-
 
 
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetpositiontype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetpositiontype.yml
@@ -3,7 +3,7 @@ name: ExcelScript.WorksheetPositionType
 uid: 'ExcelScript!ExcelScript.WorksheetPositionType:enum'
 package: ExcelScript!
 fullName: ExcelScript.WorksheetPositionType
-summary: ''
+summary: The position of a worksheet relative to another worksheet or the entire worksheet collection.
 remarks: |-
 
 
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotection.yml
@@ -46,7 +46,7 @@ methods:
     fullName: checkPassword(password)
     summary: >-
       Specifies if the password can be used to unlock worksheet protection. This method doesn't change the worksheet
-      protection state. If a password is input but no password is required to unlock worksheet protection, this method
+      protection state. If a password is entered but no password is required to unlock worksheet protection, this method
       will return false.
     remarks: ''
     isPreview: false
diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv
@@ -520,10 +520,10 @@ ExcelScript.ChartDataLabels,"setShowValue(showValue)",Method,Poor,false
 ExcelScript.ChartDataLabels,"setTextOrientation(textOrientation)",Method,Poor,false
 ExcelScript.ChartDataLabels,"setVerticalAlignment(verticalAlignment)",Method,Poor,false
 ExcelScript.ChartDataSourceType,N/A,Enum,Fine,false
-ExcelScript.ChartDataSourceType,"externalRange",EnumField,Missing,false
-ExcelScript.ChartDataSourceType,"list",EnumField,Missing,false
-ExcelScript.ChartDataSourceType,"localRange",EnumField,Missing,false
-ExcelScript.ChartDataSourceType,"unknown",EnumField,Missing,false
+ExcelScript.ChartDataSourceType,"externalRange",EnumField,Fine,false
+ExcelScript.ChartDataSourceType,"list",EnumField,Fine,false
+ExcelScript.ChartDataSourceType,"localRange",EnumField,Fine,false
+ExcelScript.ChartDataSourceType,"unknown",EnumField,Fine,false
 ExcelScript.ChartDataTable,N/A,Class,Fine,false
 ExcelScript.ChartDataTable,"getFormat()",Method,Poor,false
 ExcelScript.ChartDataTable,"getShowHorizontalBorder()",Method,Poor,false
@@ -1894,7 +1894,7 @@ ExcelScript.ImageFittingMode,N/A,Enum,Missing,true
 ExcelScript.ImageFittingMode,"fill",EnumField,Missing,false
 ExcelScript.ImageFittingMode,"fit",EnumField,Missing,false
 ExcelScript.ImageFittingMode,"fitAndCenter",EnumField,Missing,false
-ExcelScript.InsertShiftDirection,N/A,Enum,Missing,true
+ExcelScript.InsertShiftDirection,N/A,Enum,Fine,true
 ExcelScript.InsertShiftDirection,"down",EnumField,Missing,false
 ExcelScript.InsertShiftDirection,"right",EnumField,Missing,false
 ExcelScript.IterativeCalculation,N/A,Class,Poor,false
@@ -2518,6 +2518,7 @@ ExcelScript.RangeBorder,"setTintAndShade(tintAndShade)",Method,Poor,false
 ExcelScript.RangeBorder,"setWeight(weight)",Method,Poor,true
 ExcelScript.RangeCopyType,N/A,Enum,Missing,true
 ExcelScript.RangeCopyType,"all",EnumField,Missing,false
+ExcelScript.RangeCopyType,"columnWidths",EnumField,Missing,false
 ExcelScript.RangeCopyType,"formats",EnumField,Missing,false
 ExcelScript.RangeCopyType,"formulas",EnumField,Missing,false
 ExcelScript.RangeCopyType,"link",EnumField,Missing,false
@@ -2928,7 +2929,7 @@ ExcelScript.SortField,"subField",Property,Fine,false
 ExcelScript.SortMethod,N/A,Enum,Missing,true
 ExcelScript.SortMethod,"pinYin",EnumField,Missing,false
 ExcelScript.SortMethod,"strokeCount",EnumField,Missing,false
-ExcelScript.SortOn,N/A,Enum,Missing,true
+ExcelScript.SortOn,N/A,Enum,Fine,true
 ExcelScript.SortOn,"cellColor",EnumField,Missing,false
 ExcelScript.SortOn,"fontColor",EnumField,Missing,false
 ExcelScript.SortOn,"icon",EnumField,Missing,false
@@ -3301,7 +3302,7 @@ ExcelScript.WorksheetFreezePanes,"freezeColumns(count)",Method,Poor,false
 ExcelScript.WorksheetFreezePanes,"freezeRows(count)",Method,Poor,false
 ExcelScript.WorksheetFreezePanes,"getLocation()",Method,Poor,false
 ExcelScript.WorksheetFreezePanes,"unfreeze()",Method,Poor,false
-ExcelScript.WorksheetPositionType,N/A,Enum,Missing,true
+ExcelScript.WorksheetPositionType,N/A,Enum,Fine,true
 ExcelScript.WorksheetPositionType,"after",EnumField,Missing,false
 ExcelScript.WorksheetPositionType,"before",EnumField,Missing,false
 ExcelScript.WorksheetPositionType,"beginning",EnumField,Missing,false
diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts
@@ -1366,7 +1366,7 @@ export declare namespace ExcelScript {
         /**
          * Specifies if the password can be used to unlock worksheet protection.
          * This method doesn't change the worksheet protection state.
-         * If a password is input but no password is required to unlock worksheet protection, this method will return false.
+         * If a password is entered but no password is required to unlock worksheet protection, this method will return false.
          * @param password - The password to check against the protected worksheet.
          */
         checkPassword(password?: string): boolean;
@@ -1727,7 +1727,7 @@ export declare namespace ExcelScript {
          * The destination range can be `null` or can extend the source range either horizontally or vertically.
          * Discontiguous ranges are not supported.
          *
-         * @param destinationRange - The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle).
+         * @param destinationRange - The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
          * @param autoFillType - The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault".
          */
         autoFill(
@@ -2527,7 +2527,8 @@ export declare namespace ExcelScript {
         getType(): NamedItemType;
 
         /**
-         * Represents the value computed by the name's formula. For a named range, will return the range address.
+         * Represents the value computed by the name's formula. For a named range, it will return the range address.
+         * This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function.
          */
         getValue(): string | number;
 
@@ -4190,7 +4191,7 @@ export declare namespace ExcelScript {
         delete(): void;
 
         /**
-         * Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
+         * Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
          * @param dimension - The dimension of the axis where the data is from.
          */
         getDimensionDataSourceString(dimension: ChartSeriesDimension): string;
@@ -4222,7 +4223,7 @@ export declare namespace ExcelScript {
         setValues(sourceData: Range): void;
 
         /**
-         * Sets the values of the x-axis for a chart series. Only works for scatter charts.
+         * Sets the values of the x-axis for a chart series.
          * @param sourceData - The `Range` object corresponding to the source data.
          */
         setXAxisValues(sourceData: Range): void;
@@ -12186,15 +12187,27 @@ export declare namespace ExcelScript {
     }
 
     /**
-     * Specifies whether the series data range is local range, external range, list, or unknown.
+     * Specifies the data source type of the chart series.
      */
     enum ChartDataSourceType {
+        /**
+         * The data source type of the chart series is a local range.
+         */
         localRange,
 
+        /**
+         * The data source type of the chart series is an external range.
+         */
         externalRange,
 
+        /**
+         * The data source type of the chart series is a list.
+         */
         list,
 
+        /**
+         * The data source type of the chart series is unknown or unsupported.
+         */
         unknown,
     }
 
@@ -13347,6 +13360,9 @@ export declare namespace ExcelScript {
         fill,
     }
 
+    /**
+     * Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
+     */
     enum InsertShiftDirection {
         down,
 
@@ -13444,6 +13460,9 @@ export declare namespace ExcelScript {
         columns,
     }
 
+    /**
+     * Represents the part of the cell used as the sorting criteria.
+     */
     enum SortOn {
         value,
 
@@ -13766,6 +13785,9 @@ export declare namespace ExcelScript {
         notAvailable,
     }
 
+    /**
+     * The position of a worksheet relative to another worksheet or the entire worksheet collection.
+     */
     enum WorksheetPositionType {
         none,
 
@@ -13933,6 +13955,8 @@ export declare namespace ExcelScript {
         formats,
 
         link,
+
+        columnWidths,
     }
 
     enum LinkedDataTypeState {
diff --git a/generate-docs/script-inputs/excel.d.ts b/generate-docs/script-inputs/excel.d.ts
@@ -1366,7 +1366,7 @@ declare namespace ExcelScript {
         /**
          * Specifies if the password can be used to unlock worksheet protection.
          * This method doesn't change the worksheet protection state.
-         * If a password is input but no password is required to unlock worksheet protection, this method will return false.
+         * If a password is entered but no password is required to unlock worksheet protection, this method will return false.
          * @param password The password to check against the protected worksheet.
          */
         checkPassword(password?: string): boolean;
@@ -1727,7 +1727,7 @@ declare namespace ExcelScript {
          * The destination range can be `null` or can extend the source range either horizontally or vertically.
          * Discontiguous ranges are not supported.
          *
-         * @param destinationRange The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle).
+         * @param destinationRange The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
          * @param autoFillType The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault".
          */
         autoFill(
@@ -2527,7 +2527,8 @@ declare namespace ExcelScript {
         getType(): NamedItemType;
 
         /**
-         * Represents the value computed by the name's formula. For a named range, will return the range address.
+         * Represents the value computed by the name's formula. For a named range, it will return the range address.
+         * This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function.
          */
         getValue(): string | number;
 
@@ -4190,7 +4191,7 @@ declare namespace ExcelScript {
         delete(): void;
 
         /**
-         * Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
+         * Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
          * @param dimension The dimension of the axis where the data is from.
          */
         getDimensionDataSourceString(dimension: ChartSeriesDimension): string;
@@ -4222,7 +4223,7 @@ declare namespace ExcelScript {
         setValues(sourceData: Range): void;
 
         /**
-         * Sets the values of the x-axis for a chart series. Only works for scatter charts.
+         * Sets the values of the x-axis for a chart series.
          * @param sourceData The `Range` object corresponding to the source data.
          */
         setXAxisValues(sourceData: Range): void;
@@ -12186,15 +12187,27 @@ declare namespace ExcelScript {
     }
 
     /**
-     * Specifies whether the series data range is local range, external range, list, or unknown.
+     * Specifies the data source type of the chart series.
      */
     enum ChartDataSourceType {
+        /**
+         * The data source type of the chart series is a local range.
+         */
         localRange,
 
+        /**
+         * The data source type of the chart series is an external range.
+         */
         externalRange,
 
+        /**
+         * The data source type of the chart series is a list.
+         */
         list,
 
+        /**
+         * The data source type of the chart series is unknown or unsupported.
+         */
         unknown,
     }
 
@@ -13347,6 +13360,9 @@ declare namespace ExcelScript {
         fill,
     }
 
+    /**
+     * Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
+     */
     enum InsertShiftDirection {
         down,
 
@@ -13444,6 +13460,9 @@ declare namespace ExcelScript {
         columns,
     }
 
+    /**
+     * Represents the part of the cell used as the sorting criteria.
+     */
     enum SortOn {
         value,
 
@@ -13766,6 +13785,9 @@ declare namespace ExcelScript {
         notAvailable,
     }
 
+    /**
+     * The position of a worksheet relative to another worksheet or the entire worksheet collection.
+     */
     enum WorksheetPositionType {
         none,
 
@@ -13933,6 +13955,8 @@ declare namespace ExcelScript {
         formats,
 
         link,
+
+        columnWidths,
     }
 
     enum LinkedDataTypeState {
