[Admin] Publish

.openpublishing.publish.config.json

@@ -232,6 +232,10 @@
       "ReferenceTOC": "docs/docs-ref-autogen/excel_1_16/toc.yml",
       "ConceptualTOCUrl": "/office/dev/add-ins/toc.json"
     },
+    {
+      "ReferenceTOC": "docs/docs-ref-autogen/excel_1_17/toc.yml",
+      "ConceptualTOCUrl": "/office/dev/add-ins/toc.json"
+    },
     {
       "ReferenceTOC": "docs/docs-ref-autogen/excel_online/toc.yml",
       "ConceptualTOCUrl": "/office/dev/add-ins/toc.json"

docs/docfx.json

@@ -467,6 +467,18 @@
         "src": "docs-ref-autogen/excel_1_16",
         "dest": "api"
       },
+      {
+        "files": ["**/toc.yml"],
+        "group": "excel-js-1.17",
+        "src": "docs-ref-autogen/excel_1_17",
+        "dest": "api/office-js-docs-reference"
+      },
+      {
+        "files": ["**/*.md", "**/*.yml"],
+        "group": "excel-js-1.17",
+        "src": "docs-ref-autogen/excel_1_17",
+        "dest": "api"
+      },
       {
         "files": ["**/toc.yml"],
         "group": "excel-js-online",
@@ -801,6 +813,10 @@
         "dest": "excel-js-1.16",
         "moniker_range": "excel-js-1.16"
       },
+      "excel-js-1.17": {
+        "dest": "excel-js-1.17",
+        "moniker_range": "excel-js-1.17"
+      },      
       "excel-js-online": {
         "dest": "excel-js-online",
         "moniker_range": "excel-js-online"
@@ -962,6 +978,8 @@
         "docs-ref-autogen/excel_1_15/excel/**": ["excel 1.15"],
         "docs-ref-autogen/excel_1_16/**": ["excel 1.16"],
         "docs-ref-autogen/excel_1_16/excel/**": ["excel 1.16"],
+        "docs-ref-autogen/excel_1_17/**": ["excel 1.17"],
+        "docs-ref-autogen/excel_1_17/excel/**": ["excel 1.17"],
         "docs-ref-autogen/excel_online/**": ["excel online"],
         "docs-ref-autogen/excel_online/excel/**": ["excel online"],
         "docs-ref-autogen/office/**": ["common preview"],
@@ -1049,6 +1067,7 @@
         "docs-ref-autogen/excel_1_14/**": "excel",
         "docs-ref-autogen/excel_1_15/**": "excel",
         "docs-ref-autogen/excel_1_16/**": "excel",
+        "docs-ref-autogen/excel_1_17/**": "excel",
         "docs-ref-autogen/excel_online/**": "excel",
         "docs-ref-autogen/excel_1_1/excel/**": "excel",
         "docs-ref-autogen/excel_1_2/excel/**": "excel",
@@ -1066,6 +1085,7 @@
         "docs-ref-autogen/excel_1_14/excel/**": "excel",
         "docs-ref-autogen/excel_1_15/excel/**": "excel",
         "docs-ref-autogen/excel_1_16/excel/**": "excel",
+        "docs-ref-autogen/excel_1_17/excel/**": "excel",
         "docs-ref-autogen/excel_online/excel/**": "excel",
         "docs-ref-autogen/office/**": "non-product-specific",
         "docs-ref-autogen/office/office/**": "non-product-specific",

docs/docs-ref-autogen/common/toc.yml

@@ -475,6 +475,9 @@ items:
           - name: ExcelApi online-only requirement set
             href: ../../requirement-sets/excel/excel-api-online-requirement-set.md
             displayName: Excel
+          - name: ExcelApi 1.17 requirement set
+            href: ../../requirement-sets/excel/excel-api-1-17-requirement-set.md
+            displayName: Excel
           - name: ExcelApi 1.16 requirement set
             href: ../../requirement-sets/excel/excel-api-1-16-requirement-set.md
             displayName: Excel

docs/docs-ref-autogen/common_preview/toc.yml

@@ -475,6 +475,9 @@ items:
           - name: ExcelApi online-only requirement set
             href: ../../requirement-sets/excel/excel-api-online-requirement-set.md
             displayName: Excel
+          - name: ExcelApi 1.17 requirement set
+            href: ../../requirement-sets/excel/excel-api-1-17-requirement-set.md
+            displayName: Excel
           - name: ExcelApi 1.16 requirement set
             href: ../../requirement-sets/excel/excel-api-1-16-requirement-set.md
             displayName: Excel

docs/docs-ref-autogen/excel/excel.yml

@@ -9,6 +9,7 @@ enums:
   - 'excel!Excel.ArrowheadStyle:enum'
   - 'excel!Excel.ArrowheadWidth:enum'
   - 'excel!Excel.AutoFillType:enum'
+  - 'excel!Excel.Base64EncodingType:enum'
   - 'excel!Excel.BindingType:enum'
   - 'excel!Excel.BlockedErrorCellValueSubType:enum'
   - 'excel!Excel.BorderIndex:enum'
@@ -371,6 +372,7 @@ classes:
 interfaces:
   - 'excel!Excel.AllowEditRangeOptions:interface'
   - 'excel!Excel.ArrayCellValue:interface'
+  - 'excel!Excel.Base64EncodedImage:interface'
   - 'excel!Excel.BasicDataValidation:interface'
   - 'excel!Excel.BindingDataChangedEventArgs:interface'
   - 'excel!Excel.BindingSelectionChangedEventArgs:interface'
@@ -982,6 +984,8 @@ interfaces:
   - 'excel!Excel.LinkedEntityCellValue:interface'
   - 'excel!Excel.LinkedEntityId:interface'
   - 'excel!Excel.ListDataValidation:interface'
+  - 'excel!Excel.LocalImageCellValue:interface'
+  - 'excel!Excel.LocalImageCellValueCacheId:interface'
   - 'excel!Excel.NameErrorCellValue:interface'
   - 'excel!Excel.NotAvailableErrorCellValue:interface'
   - 'excel!Excel.NullErrorCellValue:interface'

docs/docs-ref-autogen/excel/excel/excel.application.yml

@@ -127,6 +127,20 @@ properties:
       content: 'readonly decimalSeparator: string;'
       return:
         type: string
+  - name: formatStaleValues
+    uid: 'excel!Excel.Application#formatStaleValues:member'
+    package: excel!
+    fullName: formatStaleValues
+    summary: >-
+      Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled. The stale
+      formulas are rendered with stale formatting if the option is enabled.
+    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'formatStaleValues: boolean;'
+      return:
+        type: boolean
   - name: iterativeCalculation
     uid: 'excel!Excel.Application#iterativeCalculation:member'
     package: excel!

docs/docs-ref-autogen/excel/excel/excel.base64encodedimage.yml

@@ -0,0 +1,35 @@
+### YamlMime:TSType
+name: Excel.Base64EncodedImage
+uid: 'excel!Excel.Base64EncodedImage:interface'
+package: excel!
+fullName: Excel.Base64EncodedImage
+summary: The base64 encoding type and data of an image.
+remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+  - name: data
+    uid: 'excel!Excel.Base64EncodedImage#data:member'
+    package: excel!
+    fullName: data
+    summary: The base64 string encoding.
+    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'data: string;'
+      return:
+        type: string
+  - name: type
+    uid: 'excel!Excel.Base64EncodedImage#type:member'
+    package: excel!
+    fullName: type
+    summary: The file type of the encoded image.
+    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'type: Base64EncodingType | "JPG" | "PNG";'
+      return:
+        type: '<xref uid="excel!Excel.Base64EncodingType:enum" /> | "JPG" | "PNG"'

docs/docs-ref-autogen/excel/excel/excel.base64encodingtype.yml

@@ -0,0 +1,26 @@
+### YamlMime:TSEnum
+name: Excel.Base64EncodingType
+uid: 'excel!Excel.Base64EncodingType:enum'
+package: excel!
+fullName: Excel.Base64EncodingType
+summary: The file type represented by the base64 encoding.
+remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+isPreview: true
+isDeprecated: false
+fields:
+  - name: JPG
+    uid: 'excel!Excel.Base64EncodingType.JPG:member'
+    package: excel!
+    summary: |-
+      The JPG file type.
+
+      * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
+    value: '"JPG"'
+  - name: PNG
+    uid: 'excel!Excel.Base64EncodingType.PNG:member'
+    package: excel!
+    summary: |-
+      The PNG file type.
+
+      * \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
+    value: '"PNG"'

docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml

@@ -9,5 +9,5 @@ isPreview: false
 isDeprecated: false
 syntax: >-
   export type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue |
-  ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue |
-  ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
+  ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | LocalImageCellValue | ReferenceCellValue |
+  StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;

docs/docs-ref-autogen/excel/excel/excel.cellvaluetype.yml

@@ -102,6 +102,14 @@ fields:
 
       * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
     value: '"LinkedEntity"'
+  - name: localImage
+    uid: 'excel!Excel.CellValueType.localImage:member'
+    package: excel!
+    summary: |-
+      Represents a `LocalImageCellValue`<!-- -->.
+
+      * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
+    value: '"LocalImage"'
   - name: notAvailable
     uid: 'excel!Excel.CellValueType.notAvailable:member'
     package: excel!

docs/docs-ref-autogen/excel/excel/excel.conditionalformat.yml

@@ -520,8 +520,8 @@ methods:
     package: excel!
     fullName: changeRuleToCellValue(properties)
     summary: Change the conditional format rule type to cell value.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;'
@@ -537,8 +537,8 @@ methods:
     package: excel!
     fullName: changeRuleToColorScale()
     summary: Change the conditional format rule type to color scale.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToColorScale(): void;'
@@ -550,8 +550,8 @@ methods:
     package: excel!
     fullName: changeRuleToContainsText(properties)
     summary: Change the conditional format rule type to text comparison.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;'
@@ -567,8 +567,8 @@ methods:
     package: excel!
     fullName: changeRuleToCustom(formula)
     summary: Change the conditional format rule type to custom.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToCustom(formula: string): void;'
@@ -584,8 +584,8 @@ methods:
     package: excel!
     fullName: changeRuleToDataBar()
     summary: Change the conditional format rule type to data bar.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToDataBar(): void;'
@@ -597,8 +597,8 @@ methods:
     package: excel!
     fullName: changeRuleToIconSet()
     summary: Change the conditional format rule type to icon set.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToIconSet(): void;'
@@ -610,8 +610,8 @@ methods:
     package: excel!
     fullName: changeRuleToPresetCriteria(properties)
     summary: Change the conditional format rule type to preset criteria.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;'
@@ -627,8 +627,8 @@ methods:
     package: excel!
     fullName: changeRuleToTopBottom(properties)
     summary: Change the conditional format rule type to top/bottom.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;'
@@ -851,8 +851,8 @@ methods:
     package: excel!
     fullName: setRanges(ranges)
     summary: Set the ranges that the conditonal format rule is applied to.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'setRanges(ranges: Range | RangeAreas | string): void;'

docs/docs-ref-autogen/excel/excel/excel.conditionalrangeformat.yml

@@ -81,8 +81,8 @@ methods:
     package: excel!
     fullName: clearFormat()
     summary: Remove the format properties from a conditional format rule. This creates a rule with no format settings.
-    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
-    isPreview: true
+    remarks: '\[ [API set: ExcelApi 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'clearFormat(): void;'

docs/docs-ref-autogen/excel/excel/excel.fielderrorcellvalue.yml

@@ -45,11 +45,13 @@ properties:
     isPreview: false
     isDeprecated: false
     syntax:
-      content: 'errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError";'
+      content: >-
+        errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError" |
+        "RichValueRelMissingFilePart";
       return:
         type: >-
           <xref uid="excel!Excel.FieldErrorCellValueSubType:enum" /> | "Unknown" | "WebImageMissingFilePart" |
-          "DataProviderError"
+          "DataProviderError" | "RichValueRelMissingFilePart"
   - name: errorType
     uid: 'excel!Excel.FieldErrorCellValue#errorType:member'
     package: excel!

docs/docs-ref-autogen/excel/excel/excel.fielderrorcellvaluesubtype.yml

@@ -16,6 +16,16 @@ fields:
 
       * \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
     value: '"DataProviderError"'
+  - name: richValueRelMissingFilePart
+    uid: 'excel!Excel.FieldErrorCellValueSubType.richValueRelMissingFilePart:member'
+    package: excel!
+    summary: >-
+      An error caused by a missing file. In this case, the RichValueRel.xml file is missing from the metro package.
+      Displays as error type \#FIELD! in Excel.
+
+
+      * \[ [API set: 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
+    value: '"RichValueRelMissingFilePart"'
   - name: unknown
     uid: 'excel!Excel.FieldErrorCellValueSubType.unknown:member'
     package: excel!

docs/docs-ref-autogen/excel/excel/excel.interfaces.applicationdata.yml

@@ -77,6 +77,20 @@ properties:
       content: 'decimalSeparator?: string;'
       return:
         type: string
+  - name: formatStaleValues
+    uid: 'excel!Excel.Interfaces.ApplicationData#formatStaleValues:member'
+    package: excel!
+    fullName: formatStaleValues
+    summary: >-
+      Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled. The stale
+      formulas are rendered with stale formatting if the option is enabled.
+    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'formatStaleValues?: boolean;'
+      return:
+        type: boolean
   - name: iterativeCalculation
     uid: 'excel!Excel.Interfaces.ApplicationData#iterativeCalculation:member'
     package: excel!